Sign in
Usage

Get usage data

Returns customer-scoped usage aggregates. Supports filtering by time range, chain, API key, grouping, and granularity. By default returns summary and balance.

get/usage

Query parameters

fromstring date-time

Start time (RFC3339). Defaults to 30 days ago.

tostring date-time

End time (RFC3339). Defaults to now.

includestring
Example:summary,balance,by_chain,by_api_key

Comma-separated list of sections to include. Options: summary, balance, by_chain, by_api_key, by_api_key_chain, top_methods, time_series, by_scenario. Default: summary,balance.

group_bystring
Example:chain

Group usage by a dimension. Options: chain, api_key, api_key,chain, method, day.

granularity'day' | 'hour'

Time bucket size. Options: day, hour. Default: day.

chain_idstring

Filter by chain ID (e.g. 1, 137, 8453).

api_key_idinteger

Filter by API key numeric ID (found in list response).

limitinteger

Maximum number of rows returned (default and max depend on config).

Response

Usage data

customer_idinteger required

Changes

Changed in 2 of the 14 revisions of this API.11