---
title: "List available metrics"
method: GET
path: "/v2/metrics"
tags: ["CustomerMetrics"]
---

# List available metrics

`GET /v2/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.

## Query parameters

- `category` string[]

## Headers

- `Request-Timeout` integer
- `Request-Timeout-Millis` integer

## Response `200`

Catalog of registered metrics.

- ListMetricsResponse — List of registered metrics available for querying.
  - `metrics` MetricDescriptor[], required
    - union — Metadata about a registered metric. `type` selects the concrete variant.
      - object — Common metadata fields shared by every metric descriptor regardless of type.
        - `name` string, required — The unique name of the metric, used as the path parameter to query it.
        - `category` string, required — The top-level grouping for this metric.
        - `description` string, required — A human-readable description of what the metric measures.
        - `unit` string — The unit of measure for the metric values, when applicable.
        - `display_name` string, required — A short human-readable name for this metric, suitable as a chart title or list label.
        - `labels` string[], required — The names of labels you can use to filter this metric.
        - `type` string, required
      - object — Common metadata fields shared by every metric descriptor regardless of type.
        - `name` string, required — The unique name of the metric, used as the path parameter to query it.
        - `category` string, required — The top-level grouping for this metric.
        - `description` string, required — A human-readable description of what the metric measures.
        - `unit` string — The unit of measure for the metric values, when applicable.
        - `display_name` string, required — A short human-readable name for this metric, suitable as a chart title or list label.
        - `labels` string[], required — The names of labels you can use to filter this metric.
        - `type` string, required
      - object — Common metadata fields shared by every metric descriptor regardless of type.
        - `name` string, required — The unique name of the metric, used as the path parameter to query it.
        - `category` string, required — The top-level grouping for this metric.
        - `description` string, required — A human-readable description of what the metric measures.
        - `unit` string — The unit of measure for the metric values, when applicable.
        - `display_name` string, required — A short human-readable name for this metric, suitable as a chart title or list label.
        - `labels` string[], required — The names of labels you can use to filter this metric.
        - `type` string, required
        - `percentiles` PercentileEntry[], required — The percentile entries this metric returns, in canonical order. Each entry's `label` matches a corresponding entry in every response point's `percentiles` array; `value` is the percentile rank (e.g. `0.5` for p50).
          - `label` string, required — The stable identifier for this percentile (e.g. `p50`, `p99`).
          - `value` number, double, required — The numeric value — the percentile rank on the descriptor, the aggregated value on a response point.
      - object — Common metadata fields shared by every metric descriptor regardless of type.
        - `name` string, required — The unique name of the metric, used as the path parameter to query it.
        - `category` string, required — The top-level grouping for this metric.
        - `description` string, required — A human-readable description of what the metric measures.
        - `unit` string — The unit of measure for the metric values, when applicable.
        - `display_name` string, required — A short human-readable name for this metric, suitable as a chart title or list label.
        - `labels` string[], required — The names of labels you can use to filter this metric.
        - `type` string, required
        - `bins` DistributionBinDescriptor[], required — The bins this distribution may emit, in canonical order. Each bin has a stable label, an inclusive lower bound, and an exclusive upper bound (omitted for the overflow bin).
          - `label` string, required — The stable identifier for this bin. Response points reference it by `HistogramBin.label`.
          - `range_min` number, double, required — The inclusive lower bound of this bin's numeric range, in the metric's `unit`.
          - `range_max` number, double — The exclusive upper bound of this bin's numeric range, in the metric's `unit`. Omitted for the overflow bin.

---

[API](https://skmtc.net/vectara/apis/vectara-rest-api-v2.md) · [All operations](https://skmtc.net/vectara/apis/vectara-rest-api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vectara/vectara-rest-api-v2/revisions/a95087fe3a20/schema)