Getting the time-series statistics¶

Note

The Admin API requires no token. The Admin API is typically protected at the network level.

Send the request as GET to the path /admin/v1/stats/timeseries.

Description¶

Returns an array of time-bucketed data points suitable for charts. Buckets with no activity are included as zero-filled entries so the array length is always exactly n.

Request¶

The following parameters are available:

Parameter	In	Type	Required	Description
`bucket`	query	`string`	no	Bucket size.
`n`	query	`integer`	no	Number of buckets to return.
`until`	query	`integer`	no	End of the time range as a Unix timestamp in seconds. Defaults to now.
`tenant_id`	query	`string`	no	Filter to a single tenant UUID. When present only that tenant's requests are included in each bucket.

Example¶

Example of the response body:

[
  {
    "ts": 0,
    "requests": 0,
    "blocked": 0,
    "cost_usd": 0.0
  }
]

Responses¶

The endpoint answers the request with the following status codes:

Status code	Description
`200`	Array of time-bucketed data points.