Skip to main content
GET
Get usage

Authorizations

Authorization
string
header
required

API key obtained from the OpenMic dashboard.

Query Parameters

group_by
enum<string>
default:day

Bucket granularity for the breakdown.

Available options:
day,
week,
month
from_date
string<date-time>

Start of the range (inclusive, ISO 8601).

to_date
string<date-time>

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

Response

Usage totals and per-period breakdown.

group_by
enum<string>
required

Bucket granularity used for the breakdown.

Available options:
day,
week,
month
start_date
string<date-time>
required

Start of the reported range (inclusive).

end_date
string<date-time>
required

End of the reported range (exclusive).

total_minutes
number
required

Total call minutes used in the range.

Example:

16.5

total_sms_sent
integer
required

Total outbound SMS messages sent in the range.

Example:

3

breakdown
object[]
required