Sign in
CustomerMetrics

List available metrics

Returns the catalog of registered metrics that you can query via /v2/metrics/{metric_name}, both system metrics and the account's custom metrics. Use it to discover metric names, types, and dimensions.

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",
      "dimensions": [
        "agent_keys"
      ],
      "origin": "system",
      "type": "counter"
    }
  ]
}

Changes

Changed in 1 of the 13 revisions of this API.12

  • de6b34bc4a4f12See the full diff
    • ○

      response property metrics/items/oneOf[CounterMetricDescriptor]/allOf[MetricDescriptorBase]/labels deprecated

      response-property-deprecated

    • ○

      response property metrics/items/oneOf[DistributionMetricDescriptor]/allOf[MetricDescriptorBase]/labels deprecated

      response-property-deprecated

    • ○

      response property metrics/items/oneOf[GaugeMetricDescriptor]/allOf[MetricDescriptorBase]/labels deprecated

      response-property-deprecated

    • ○

      response property metrics/items/oneOf[PercentilesMetricDescriptor]/allOf[MetricDescriptorBase]/labels deprecated

      response-property-deprecated

    • ○

      added the required property ////////// to the response with the status

      response-required-property-added

    • ○

      added the required property ////////// to the response with the status

      response-required-property-added

    • ○

      added the required property ////////// to the response with the status

      response-required-property-added

    • ○

      added the required property ////////// to the response with the status

      response-required-property-added

    • ○

      added the required property ////////// to the response with the status

      response-required-property-added

    • ○

      added the required property ////////// to the response with the status

      response-required-property-added

    • ○

      added the required property ////////// to the response with the status

      response-required-property-added

    • ○

      added the required property ////////// to the response with the status

      response-required-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog