Query Agent Metrics

GET 
/api/v2/telemetry/metrics

Retrieves collected agent metrics from VictoriaMetrics (or Elasticsearch fallback), filtered by device, topics, metric names and time range. Intended to back metric dashboards in the UI.

Request

Query Parameters

deviceId string

Filter by a single device ID

topics string[]

Filter by one or more topics

names string[]

Filter by one or more metric names

from string

Start of the time range (ISO 8601). Defaults to 1 hour ago.

to string

End of the time range (ISO 8601). Defaults to now.

step string

Aggregation resolution for the time series (e.g., 30s, 1m, 5m). Default 60s.

limit number

Max number of metric points to return

Responses

200

application/json

Schema

Schema

total numberrequired

Total number of returned metric points

metrics

object[]

required

Matching metric points ordered by time ascending

Array [

deviceId stringrequired

Device identifier that generated/forwarded the metric

topic stringrequired

Topic category of the metric

name stringrequired

Metric name (e.g., cpu_usage, memory_usage)

value numberrequired

Metric numeric value

unit string

Unit of the metric (e.g., percent, bytes, ms)

timestamp stringrequired

Timestamp of the sample (ISO 8601)

labels object

Additional labels/tags for the metric

]

Example (from schema)

{
  "total": 0,
  "metrics": [
    {
      "deviceId": "string",
      "topic": "string",
      "name": "string",
      "value": 0,
      "unit": "string",
      "timestamp": "string",
      "labels": {}
    }
  ]
}

Loading...