Skip to navigation

Read usage aggregates

Returns job counts for the calling environment over a half-open UTC date window: start_date is included, end_date is excluded. With neither given the window is the last thirty full UTC days plus today. Counts are operational aggregates, not billing authority, and the report carries no account identifier.

Authentication

X-API-Keystring

API key for one environment of your account. Keep server-side; never expose in browser clients.

Query parameters

start_datedate or nullOptional

First UTC date included (inclusive), YYYY-MM-DD.

end_datedate or nullOptional

First UTC date excluded (exclusive), YYYY-MM-DD.

Response

Successful Response
as_ofdatetime
dayslist of objects
periodobject

The half-open window [start_date, end_date) in UTC calendar days.

productslist of objects
totalsobject

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
503
Service Unavailable Error