Skip to main content

Get usage metrics

GET 
/v0/usage/metrics

Get usage metrics for the authenticated organization.

Authentication: Requires valid API key in 'api-key' header. The organization is automatically deduced from the API key via VerifyTokenMiddleware.

Date Range Defaults:

  • If start_date is not provided, defaults to 30 days ago
  • If end_date is not provided, defaults to current time (with buffer applied)

Data Completeness: Metrics include only completed sessions, test runs, and datapoints. A configurable time buffer may be applied to ensure data completeness.

Metrics Included:

  • voice_minutes: Sum of audio/voice minutes from completed sessions
  • simulations: Count of completed test runs (all types: voice and non-voice)
  • datapoints: Count of non-error datapoints
  • checks: Total check executions from test runs and monitors

Example Usage:

# Last 30 days (default)
GET /v0/usage/metrics

# Specific date range
GET /v0/usage/metrics?start_date=2026-01-01T00:00:00Z&end_date=2026-01-31T23:59:59Z

# Custom start, default end
GET /v0/usage/metrics?start_date=2026-01-01T00:00:00Z

Request​

Responses​

Successful Response