Skip to navigation
Channels APIMetrics

Query Metrics

Execute arbitrary PromQL range query. Returns Prometheus format.

Authentication

AuthorizationBearer

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

Query parameters

querystringRequired
PromQL query
startstringRequired

Start time (ISO8601 or Unix timestamp)

endstringRequired

End time (ISO8601 or Unix timestamp)

stepstringOptionalDefaults to 60s

Query resolution step (e.g. 60s, 5m, 1h)

Response

Successful Response
statusstring
'success' or 'error'
dataobject or nullOptional
Data section of a matrix response.
errorstring or nullOptional
Error message if status is 'error'
errorTypestring or nullOptional

Errors

422
Unprocessable Entity Error