Get aggregated metrics with time series for any aggregation level

curl -G /v2/metrics \
     -d groupBy=nodegroup \
     -d groupId=550e8400-e29b-41d4-a716-446655440000 \
     --data-urlencode metricNames=dcgm_fi_dev_gpu_util,cpu_used_percent \
     -d step=5m \
     -d window=24h

{
  "metrics": [
    {
      "warning": {
        "code": "invalidMetricValues",
        "message": "1 data point(s) had invalid values and were omitted."
      },
      "aggregation": "average",
      "displayName": "GPU Utilization",
      "emptyStateMessage": "No error detected",
      "falseLabel": "Down",
      "name": "dcgm_fi_dev_gpu_util",
      "result": [
        {
          "displayLabel": "GPU 0",
          "label": {},
          "values": "[[1705276800, 0.723], [1705277100, 0.741]]"
        }
      ],
      "trueLabel": "Up",
      "unit": "ratio"
    }
  ],
  "step": "5m",
  "timeRange": {
    "end": "2024-01-01T01:00:00Z",
    "start": "2024-01-01T00:00:00Z"
  }
}

Returns historical chart data for customer, node group, compute zone, or node level. This endpoint follows the v1/metrics/query_range pattern with a unified interface. Aggregation functions are determined by metric configuration in base-config.yaml.

Query parameters

groupByenumRequired

The aggregation level to group metrics by

Allowed values:

groupIdstringOptional

The ID of the entity (required for nodegroup, computezone, node; not needed for customer level)

metricNameslist of stringsRequired

Comma-separated list of metric names to query (e.g., dcgm_fi_dev_gpu_util,cpu_used_percent,memory_used_percent)

startTimestringOptional

Start time in RFC3339 format (required for absolute mode, e.g., 2024-01-01T00:00:00Z)

endTimestringOptional

End time in RFC3339 format (required for absolute mode, e.g., 2024-01-01T01:00:00Z)

timeModeenumOptional

Time mode for range selection. Defaults to absolute.

Allowed values:

windowstringOptional

Relative duration window (required for relative mode). Uses Go duration syntax — valid units: h, m, s (e.g. 24h, 1h30m, 90m). ‘d’ is not supported; use hours instead (e.g. 168h for 7 days)

stepstringRequired

Query resolution step width in duration format (e.g., 1m, 5m, 1h). Minimum step width is 1 minute.

Response

Metrics with time series for the requested aggregation level

metricslist of objectsOptional

stepstringOptional

Query resolution step width from request

timeRangeobjectOptional

Errors

499

Client Closed Request Error