Skip to main content
GET
Read sprite usage

Authorizations

Authorization
string
header
required

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

Path Parameters

sprite
string
required

Query Parameters

start
string<date-time>
required

Inclusive start time in ISO8601 format.

Example:

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

end
string<date-time>

Exclusive end time in ISO8601 format. Defaults to now.

Example:

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

interval
string

Bucket duration, such as 1h, or auto. Minimum 1s. Omit for a single total.

Example:

"1h"

cluster_id
string

Sprite's cluster. Defaults to default.

Example:

"default"

Response

Success

Recorded provider usage in time buckets

end
string<date-time>
required

Exclusive end in UTC.

interval
string | null
required

Resolved bucket duration, or null when interval is omitted.

partial
boolean
required

True when missing minute records were detected. Returned totals include available records only and may understate usage. False means no gaps were detected, not proof of complete collection.

start
string<date-time>
required

Inclusive start in UTC.

usage
object[]
required

Available usage ordered by start time and sprite. Missing records contribute zero to these sums. Check partial before treating them as complete totals.