---
title: "query monitor by promql"
method: POST
path: "/query/promql"
---

# query monitor by promql

`POST /query/promql`

## Headers

- `traceparent` string
- `Bk-Query-Source` string
- `X-Bk-Scope-Space-Uid` string
- `X-Bk-Scope-Skip-Space` string

## Request body

- StructuredQueryPromQL
  - `add_dimensions` string[] — AddDimensions 额外添加的聚合维度，会与每个 function.dimensions 合并
  - `bk_biz_ids` string[]
  - `down_sample_range` string — DownSampleRange 降采样：大于Step才能生效，可以为空
  - `end` string
  - `instant` boolean — 瞬时数据
  - `is_verify_dimensions` boolean
  - `limit` integer
  - `look_back_delta` string — LookBackDelta 偏移量
  - `match` string
  - `max_source_resolution` string
  - `not_align_influxdb` boolean — 不与influxdb对齐
  - `not_time_align` boolean
  - `promql` string
  - `reference` boolean
  - `slimit` integer
  - `start` string
  - `step` string
  - `timezone` string — Timezone 时区

## Response `200`

OK

- HttpPromData
  - `is_partial` boolean
  - `result_table_id` string[] — ResultTableID 来自 QueryReference 路由解析结果；查询响应只暴露 RT 列表，不返回完整 RouteInfo。
  - `series` HttpTablesItem[]
    - `columns` string[]
    - `group_keys` string[]
    - `group_values` string[]
    - `metric_name` string
    - `name` string
    - `stat` HttpStatItem
      - `avg` HttpStatPoint
      - `count` HttpStatPoint
      - `last` HttpStatPoint
      - `max` HttpStatPoint
      - `min` HttpStatPoint
      - `sum` HttpStatPoint
    - `types` string[]
    - `values` array[]
      - unknown[]
        - unknown
  - `status` MetadataStatus
    - `code` string
    - `message` string
  - `trace_id` string

## Other responses

- `400` — Bad Request

## Changes

- **2024-02-28** `498668108be1` — 1 info
  - endpoint added
- **2023-10-27** `2943dd96f5a3` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/tencentblueking/apis/bk-unify-query/changes/query/promql/post.md)

---

[API](https://skmtc.dev/tencentblueking/apis/bk-unify-query.md) · [All operations](https://skmtc.dev/tencentblueking/apis/bk-unify-query/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/tencentblueking/bk-unify-query/revisions/f26136596521/schema)
