Skip to main content
GET
Get usage analytics

Authorizations

Authorization
string
header
required

OAuth 2.1 authorization-code flow with PKCE.

Headers

X-Workspace-Id
string

Workspace this request operates in — the workspace id (wksp_…) or the organization id, from GET /workspaces. Required with an API key, which carries no workspace (400 WORKSPACE_REQUIRED without it). With an OAuth token it defaults to the workspace the token was issued for. Responds 403 WORKSPACE_FORBIDDEN when the caller is not a current member, rather than falling back to another workspace.

Query Parameters

period
enum<string>
default:QUARTER

Aggregation window.

Available options:
DAY,
WEEK,
MONTH,
QUARTER,
YEAR

Response

Successful response.

Aggregated usage analytics with time-bucketed data. Granularity depends on the period: DAY -> hourly buckets WEEK, MONTH -> daily buckets QUARTER, YEAR -> monthly buckets

buckets
object[]
required

Time-bucketed usage (hourly, daily, or monthly depending on period)

byQuality
object[]
required

Breakdown by stream quality tier

sessionCount
integer
required

Number of streaming sessions in the requested period

totalCredits
integer
required

Total credits spent in the requested period

totalMinutes
integer
required

Total minutes in the requested period