---
title: "list all metrics"
method: GET
path: "/api/v1/metrics"
tags: ["Metric"]
---

# list all metrics

`GET /api/v1/metrics`

list all metrics meta info, return by groups

## Query parameters

- `scope` 'OBCLUSTER' | 'OBTENANT', required

## Response `200`

OK

- object
  - `data` ResponseMetricClass[], required
    - `description` string, required
    - `metricGroups` ResponseMetricGroup[], required
      - `description` string, required
      - `metrics` ResponseMetricMeta[], required
        - `description` string, required
        - `key` string, required
        - `name` string, required
        - `unit` string, required
      - `name` string, required
    - `name` string, required
  - `message` string, required
  - `successful` boolean, required

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `500` — Internal Server Error

---

[API](https://skmtc.dev/oceanbase/apis/oceanbase-dashboard-api.md) · [All operations](https://skmtc.dev/oceanbase/apis/oceanbase-dashboard-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/oceanbase/oceanbase-dashboard-api/revisions/fa579fa6f72d/schema)