Skip to main content
GET
Account KPI strip + breakdowns + time series for the Usage page

Authorizations

Authorization
string
header
required

API key: key id as the username, secret as the password. An account API key carries the same scopes as an OAuth token and is checked against the scopes listed under oauth2 on each operation. A trigger API key is limited to its trigger's workspace and reaches only the session operations that list this scheme alongside the oauth2 scopes.

Path Parameters

account_id_or_name
string
required

Query Parameters

days
integer
default:30

Window in days, ending now

Required range: 1 <= x <= 365
start
string<date> | null

First day, YYYY-MM-DD; overrides days with end

end
string<date> | null

Last day, YYYY-MM-DD

provider
string | null
model
string | null
platform
string | null
workspace_id
string | null

Only this workspace, by ID or full name

agent_id
string | null

Only this agent, by ID or full name

user_id
string | null
breakdown_limit
integer | null

Rows to keep in each breakdown, e.g. 5 for the top five

Required range: 1 <= x <= 500

Response

Successful response

The response is of type object.