Skip to main content
GET
Retrieve usage history
0 credits Requires logs:read permission. See the guide for examples and usage.

Authorizations

Authorization
string
header
required

Send Authorization: Bearer <API_KEY>. Keys have full access unless restricted to scopes.

Query Parameters

from
string<date-time>

Start of the range, as an ISO 8601 timestamp. Defaults to 24 hours before to for hour, 30 days for day, and 366 days for month.

Example:

"2026-09-01T00:00:00Z"

to
string<date-time>

End of the range, as an ISO 8601 timestamp. Defaults to now.

Example:

"2026-10-01T00:00:00Z"

interval
enum<string>
default:day

Bucket size. hour covers up to 7 days; day and month cover up to 366 days. Buckets start on UTC boundaries.

Available options:
hour,
day,
month
group_by
enum<string>

Split each bucket by endpoint path, API key, or HTTP status code.

Available options:
path,
key_id,
status_code

Response

Usage over time

data
object[]
required

One bucket per interval, oldest first. Intervals without usage are included with zero totals.

total_credits_used
integer
required

Credits charged across the range.

total_request_count
integer
required

Requests made across the range.

interval
enum<string>
required

Bucket size used.

Available options:
hour,
day,
month
from
string<date-time>
required

Start of the range.

to
string<date-time>
required

End of the range.

request_id
string<uuid>
required

Unique ID of this request, also in X-Request-Id. Include it when contacting support.

Example:

"3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91"

key_metadata
object

Credits this request used and your remaining balance.