---
title: "query metrics"
method: POST
path: "/api/v1/metrics/query"
tags: ["Metric"]
---

# query metrics

`POST /api/v1/metrics/query`

query metric data

## Request body

- ParamMetricQuery
  - `groupLabels` string[]
  - `labels` CommonKVPair[]
    - `key` string, required
    - `value` string, required
  - `metrics` string[]
  - `queryRange` ParamQueryRange
    - `endTimestamp` number
    - `startTimestamp` number
    - `step` integer

## Response `200`

OK

- object
  - `data` ResponseMetricData[], required
    - `metric` ResponseMetric, required
      - `labels` CommonKVPair[]
        - `key` string, required
        - `value` string, required
      - `name` string
    - `values` ResponseMetricValue[], required
      - `timestamp` number, required
      - `value` number, 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)