Observability and analytics
The public API includes several routes that help you observe system and session state without treating that information as filesystem content.
Session health
Health-related routes include:
GET /v1/sessions/{sessionId}/health/v1/sessions/{sessionId}/health/report/v1/sessions/{sessionId}/health:testResults
Use these when your product needs to expose session state, diagnostic summaries, or test-oriented status information.
Session analytics
Analytics routes include:
/v1/sessions/{sessionId}/analytics
Use analytics for derived summaries, reporting, or higher-level insight tied to a session.
Usage
Usage visibility includes:
/v1/usage
Use this route family when your product needs top-level usage reporting or account-facing consumption views.
CAS metrics
The public contract also includes metrics-oriented routes such as:
/v1/metrics/cas/v1/metrics/cas/refcounts
These are useful when your product needs content-addressable-store visibility without exposing internal implementation details to the user.
Design guidance
Keep observability data separate from workflow content:
- Do not store health summaries as files.
- Do not model usage data as annotations.
- Use the dedicated public visibility routes that already exist.