Sign in
latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-15394599.9 KB

58dc5cff0ca7

Usage

Get usage

Returns call-minutes and sent-SMS usage for your organization, grouped by day, week, or month (UTC buckets; weekly buckets start on Monday). When from_date is omitted, the range defaults to the last 30 days for day, 12 weeks for week, and 12 months for month.

get/v2/usage

Query parameters

group_by'day' | 'week' | 'month'

Bucket granularity for the breakdown.

from_datestring date-time

Start of the range (inclusive, ISO 8601).

to_datestring date-time

End of the range (exclusive, ISO 8601). Defaults to now.

Response

Usage totals and per-period breakdown.

group_by'day' | 'week' | 'month' required

Bucket granularity used for the breakdown.

start_datestring date-time required

Start of the reported range (inclusive).

end_datestring date-time required

End of the reported range (exclusive).

total_minutesnumber required

Total call minutes used in the range.

total_sms_sentinteger required

Total outbound SMS messages sent in the range.

Example response

{
  "total_minutes": 16.5,
  "total_sms_sent": 3,
  "breakdown": [
    {
      "period_start": "2026-07-10",
      "minutes": 6.5,
      "sms_sent": 2
    }
  ]
}