Skip to main content
GET
Get usage statistics

Authorizations

Authorization
string
header
required

Bearer token authentication used for standard API calls. Format: 'Bearer YOUR_API_KEY'

Query Parameters

start
string<date>
required

Start of the usage period (inclusive) in ISO 8601 format, this also sets the timezone of the grouped usage data

end
string<date>

End of the usage period (inclusive) in ISO 8601 format, if not specified, usage data will be returned up to the current time

customer_id
string

Filter usage by customer ID

meter_id
string

Filter usage by meter ID

metadata_filters
string

Filter usage by metadata key-value pairs. Must be a JSON array of [key, value] pairs, where both key and value are strings. Keys must contain only ASCII letters, numbers, and underscores (no spaces or special characters). Example: [['user_id', '123'], ['session_id', 'abc']]

Response

Usage statistics

items
object[]
required
totals
object
required