Skip to main content
GET
Get usage overview

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

starts_after
string<date-time>
required

Start of the window, inclusive. Must carry a UTC offset, e.g. 2026-07-30T00:00:00Z. With ends_before it may cover at most 90 days.

ends_before
string<date-time>
required

End of the window, exclusive: an event at exactly this instant belongs to the next window, so consecutive windows tile without double-counting. Must carry a UTC offset, and must be after starts_after.

granularity
enum<string>
required

Bucket width, which also sets how many points come back — the series is dense, so a 90-day window is 13 weekly points or roughly 2,160 hourly ones.

Available options:
hour,
day,
week
timezone
string
default:UTC

IANA zone name the buckets are truncated in, so a day starts at local midnight and a week on the local Monday. A fixed offset such as +05:30 is not accepted, because an offset cannot express DST.

Response

Successful Response

Usage totals and the series behind them, for one time window.

The requested window, granularity and timezone are echoed back, so the response describes exactly what it covers. buckets is oldest first and includes empty buckets, so it can be charted without further processing.

starts_after
string<date-time>
required
ends_before
string<date-time>
required
granularity
enum<string>
required

How wide each bucket of a usage series is.

Available options:
hour,
day,
week
timezone
string
required
summary
UsageSummaryResponse · object
required

Totals for the whole window, summed from the buckets below them.

total_participants counts the people who connected — a participant who drops and rejoins counts twice, and the translator serving each room is not counted, though its minutes are included in total_minutes.

buckets
UsageBucketResponse · object[]
required