v2

latestOpenAPI 3.0.0SolarWinds Software Services Agreement2026-07-2167105153.0 KB

metrics

Get metric info by name

Get information about a given metric.

get/v1/metrics/{name}

Path parameters

namestring required

Metric name.

Response

The request has succeeded.

namestring required

Name of the metric.

displayNamestring nullable

Display name of the metric. A short description of the metric.

descriptionstring nullable

Description of the metric. A detailed description of the metric.

unitsstring nullable

Unit of the metric.

formulastring nullable

Formula of the metric.

lastReportedTimestring date-time nullable

Last reported time of the metric.

Example response

{
  "name": "composite.custom.system.disk.io.rate",
  "displayName": "Disk IO rate",
  "description": "Disk bytes transferred per second",
  "units": "bytes/s",
  "formula": "rate(system.disk.io[5m]",
  "lastReportedTime": "2024-11-25T16:38:24Z"
}