Skip to main content
GET
cURL

Authorizations

X-API-Key
string
header
required

Pass your API key in the X-API-Key header (recommended).

Query Parameters

period
enum<string>
default:current

current: the organization's billing period (the UTC calendar month without a subscription). today: the current UTC day.

Available options:
current,
today

Response

OK

api_key
object
required

The key the request authenticated with. Only its prefix is returned, never the full key.

billable_requests
integer<int64>
required

Requests this key made that bill per call: successful calls to priced endpoints, and calls to paid MCP tools, which are metered when the call starts and so count even when the tool then fails or is denied. Free endpoints such as /v1/me are never counted, nor are endpoints and MCP tools billed through plan features rather than per call (alerts, the episode archive and stream), nor a retried write answered from its first response under an Idempotency-Key.

endpoints
object[] | null
required

Usage by endpoint and MCP tool, busiest first, at most 100 rows.

endpoints_truncated
boolean
required

True when the key called more endpoints than endpoints lists. The totals above still cover all of them unless totals_partial is set.

errors
integer<int64>
required

Requests that returned an HTTP status of 400 or above.

period
object
required

The window the usage covers.

requests
integer<int64>
required

Requests this key made in the period, including failed and free ones.

totals_partial
boolean
required

True in the rare case a key called more distinct endpoints, tools and unrouted paths than one report reads (5,000). requests still counts every request, but billable_requests and errors then cover only the busiest 5,000 of them.