Skip to main content
GET
Read settled usage report

Authorizations

Authorization
string
header
required

Send a dashboard session token, an account API key (agt_t), or a command-line credential (afc_) as a Bearer token. Each endpoint lists accepted credential types.

Query Parameters

period
string

month (default) or today, in Coordinated Universal Time (UTC).

fleet_id
string

Exact runtime fleet identifier.

model
string

Exact recorded model identifier.

through_at
string<date-time>

Inclusive cutoff with millisecond precision; defaults to now. Use the report timestamp to preserve its view.

limit
integer<int32>

Page size: 1 to 100, default 50.

Required range: x >= 0
starting_after
string

Opaque continuation for the same query and page size.

activity_type
string

runtime or setup; absent selects both.

Response

OK

The selected account's current settled usage report.

activities
object
required

Bounded grouped activities, newest first.

filters
object
required

Unfiltered period choices, never limited to the current page.

from_at
string<date-time>
required

Inclusive beginning of the selected period.

period
string
required

month or today, both interpreted in Coordinated Universal Time (UTC).

spending
object
required

Full-period spending groups.

through_at
string<date-time>
required

Inclusive reporting cutoff, retained by continuations.

totals
object
required

Totals across every matching settled line.