Query Metrics

get /ui/connectors/channels-api/latest/metrics/query/

Execute arbitrary PromQL range query. Returns Prometheus format.

Query parameters

query string Required
PromQL query
start string Required
Start time (ISO8601 or Unix timestamp)
end string Required
End time (ISO8601 or Unix timestamp)
step string Optional Defaults to 60s
Query resolution step (e.g. 60s, 5m, 1h)

Response

200 Successful Response
statusstringRequired
'success' or 'error'
dataobjectOptional
Show 2 variantsHide 2 variants
PrometheusMatrixDataobject
Data section of a matrix response.
resultTypestringOptionalDefaults to matrix
resultlist of objectsPrometheusMatrixResultRequired
Show 2 propertiesHide 2 properties
metricobjectPrometheusMetricLabelsRequired
Metric labels from Prometheus. Allows arbitrary labels.
Show 3 propertiesHide 3 properties
serverIDobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

nameobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

jobobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

valueslist of list of itemssRequired
Array of [unix_timestamp, value_string] pairs
nullnull

Variant 2: null

errorobjectOptional
Error message if status is 'error'
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

errorTypeobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

Errors

422 Validation Error
detaillist of objectsValidationErrorOptional
Show 5 propertiesHide 5 properties
loclist of objectsRequired
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

integerinteger

Variant 2: integer

msgstringRequired
typestringRequired
inputanyOptional
ctxobjectOptional