Skip to main content
GET
Get the balance-over-time series

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

start_time
string<date-time>
required

Range start (ISO 8601)

end_time
string<date-time>
required

Range end (ISO 8601)

interval
enum<string>
default:day
Available options:
hour,
day
timezone
string
default:UTC

IANA timezone for buckets

Response

Successful Response

The balance-over-time series for the usage overview chart.

buckets
CreditBalancePointSchema · object[]
required

Zero-gap series; the last known balance carries through empty buckets.

clamped_start
string<date-time> | null
required

Set when the requested start predated the detail boundary and the series was clamped.

interval
string
required

Bucket size as served: hour or day.