Skip to main content
GET
Get organization usage

Authorizations

Authorization
string
header
required

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

Query Parameters

from
string

Window start (ISO 8601). Default: 30 days before to.

to
string

Window end (ISO 8601). Default: now.

interval
enum<string>

Bucket size for the series. Default day; hour requires a range of at most 8 days.

Available options:
,
hour,
day
api_key_ids
string

Comma-separated API key uuids to filter by (at most 50).

group_by
enum<string>

Optional grouping of the request series.

Available options:
,
none,
api_key,
endpoint,
status_class

Response

Organization usage overview.

endpoints
object[] | null
required

Per-route breakdown, requests desc.

headline
object
required

Window totals.

keys
object[] | null
required

Per-API-key breakdown, requests desc.

latency_series
object[] | null
required

Latency per bucket, ungrouped.

products
object[] | null
required

Billable products and spend.

range
object
required

The resolved query window.

series
object[] | null
required

Requests per bucket, zero-filled.

$schema
string<uri>
read-only

A URL to the JSON Schema for this object.

Example:

"https://alpha.api.trycaesar.com/UsageOverviewResponse.json"