Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Send your API key as Authorization: Bearer YOUR_API_KEY.

Query Parameters

dateFromUTC
string

Start of the window. A UTC ISO 8601 timestamp is canonical; a plain YYYY-MM-DD date is accepted and read as that day at 00:00:00Z. A timestamp must carry Z or an explicit offset, since one without a zone would be read as server-local time and shift the window. An empty string clears the bound. Anything else is a 400 rather than a silently wrong window. Billing windows are whole UTC days, so a timestamp selects the day it falls on. Omit both bounds for the last 30 days. The window can cover at most 366 days.

dateToUTC
string

End of the window, inclusive. Defaults to today. A UTC ISO 8601 timestamp is canonical; a plain YYYY-MM-DD date is accepted and covers that whole day, through 23:59:59.999Z. A timestamp must carry Z or an explicit offset, since one without a zone would be read as server-local time and shift the window. An empty string clears the bound. Anything else is a 400 rather than a silently wrong window. Billing windows are whole UTC days, so a timestamp selects the day it falls on.

groupBy
enum<string>
default:sub_account

Break the window down by sub_account (the default) or by day.

Available options:
day,
sub_account

Response

Usage for the window.

success
boolean
required
Example:

true

data
object
required