Query Metrics

Channels API · metrics

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

Execute arbitrary PromQL range query. Returns Prometheus format.

Query parameters

Example request

curl -X GET "/ui/connectors/channels-api/latest/metrics/query/?step=60s"

Responses

200 — Successful Response

• status · string · Required — 'success' or 'error'
• data · object · Optional
  • One of the following variants:
    • PrometheusMatrixData (object)
      • resultType · string · Optional · Defaults to matrix
      • result · list of objects · Required
        • Array items (object):
          • metric · object · Required — Metric labels from Prometheus. Allows arbitrary labels.
            • serverID · object · Optional
              • One of the following variants:
                • string (string)
                • null (null)
            • name · object · Optional
              • One of the following variants:
                • string (string)
                • null (null)
            • job · object · Optional
              • One of the following variants:
                • string (string)
                • null (null)
          • values · list of list of items · Required — Array of [unix_timestamp, value_string] pairs
            • Array items (list of items):
    • null (null)
• error · object · Optional — Error message if status is 'error'
  • One of the following variants:
    • string (string)
    • null (null)
• errorType · object · Optional
  • One of the following variants:
    • string (string)
    • null (null)

Example:

{
  "status": "string",
  "data": {
    "resultType": "matrix",
    "result": [
      {
        "metric": {
          "serverID": "string",
          "name": "string",
          "job": "string"
        },
        "values": [
          []
        ]
      }
    ]
  },
  "error": "string",
  "errorType": "string"
}

422 — Validation Error

• detail · list of objects · Optional
  • Array items (object):
    • loc · list of objects · Required
      • Array items (object):
        • One of the following variants:
          • string (string)
          • integer (integer)
    • msg · string · Required
    • type · string · Required
    • input · any · Optional
    • ctx · object · Optional

Example:

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}