Skip to main content
GET
Get usage

Authorizations

Authorization
string
header
required

Your API key from the Wave dashboard. Sandbox keys start sk_sandbox_; production keys start sk_live_. Send as Authorization: Bearer <key>. Some endpoints require a production key and specific scopes.

Query Parameters

from
string<date-time>

Start of the period (ISO 8601 date-time), inclusive. Needed with group_by=day or hour.

to
string<date-time>

End of the period (ISO 8601 date-time), inclusive. Needed with group_by=day or hour.

queue_id
string

Only calls from this queue. Only callback calls carry a queue id.

group_by
enum<string>

Also return groups: day or hour (Asia/Riyadh buckets), status (raw call status) or queue (the queues that have calls).

Available options:
day,
hour,
status,
queue

Response

Usage for the period

data
object
required
period
object
required

The period the numbers cover. null means no bound.

groups
object[]

Only present when group_by was sent.