v2

OpenAPI 3.0.02026-08-051996591.2 MB

CustomerMetrics

List available metrics

Returns the catalog of registered metrics that you can query via /v2/metrics/{metric_name}. Use it to discover metric names, types, and supported labels.

get/v2/metrics

Query parameters

categorystring[]

Restricts the returned catalog to metrics in these categories. When omitted, the response includes all categories.

Headers

Request-Timeoutinteger

The platform makes a best effort to complete the request in the specified seconds, or it times out.

Request-Timeout-Millisinteger

The platform makes a best effort to complete the request in the specified milliseconds, or it times out.

Response

Catalog of registered metrics.

Example response

{
  "metrics": [
    {
      "name": "agent.trace.duration_ms",
      "category": "agent",
      "unit": "ms",
      "display_name": "Agent turn duration percentiles",
      "labels": [
        "agent_keys"
      ],
      "type": "counter"
    }
  ]
}