Skip to main content

Health, analytics, and usage

These routes expose visibility data, not normal content.

Health routes​

Key routes:

  • GET /v1/sessions/{sessionId}/health
  • POST /v1/sessions/{sessionId}/health/report
  • POST /v1/sessions/{sessionId}/health:testResults

Use health routes for:

  • current test status
  • reporting fresh results
  • session-level quality indicators

Analytics route​

Key route:

  • GET /v1/sessions/{sessionId}/analytics

Use analytics when you want higher-level insight into the session, such as activity volume, checkpoint counts, restore counts, or time-to-first-write style measures.

Usage route​

Key route:

  • GET /v1/usage

Use usage when you want tenant-level aggregates such as session-hours, storage, or egress over a time window.

Keep these views separate​

Do not merge these into one undifferentiated “stats” surface in your product.

They answer different questions:

  • health asks “is this session currently passing or failing?”
  • analytics asks “what happened during this session?”
  • usage asks “what did this tenant consume over time?”