---
title: "get query description"
method: GET
path: "/queries/{query_id}"
---

# get query description

`GET /queries/{query_id}`

## Query parameters

- `db` string
- `project` string

## Headers

- `x-request-id` string
- `Authorization` string

## Response `200`

OK

- object
  - `name` string, required
  - `type` 'ANALYTICS' | 'STREAMING', required
  - `text` string, required
  - `description` string, required
  - `meta` Meta, required
    - `started_at` string, date-time, required
    - `finished_at` string, date-time, required
  - `issues` QueryError
    - `details` Issue[]
      - `position` Position
        - `row` integer
        - `column` integer
        - `file` string
      - `message` string
      - `end_position` Position
        - `row` integer
        - `column` integer
        - `file` string
      - `issue_code` integer
      - `severity` 'FATAL' | 'ERROR' | 'WARNING' | 'INFO'
      - `issues` Issue[]
    - `message` string, required
  - `result_sets` ResultSetMeta[], required
    - `rows_count` integer, required
    - `truncated` boolean, required
  - `status` 'RUNNING' | 'COMPLETED' | 'FAILED', required
  - `id` string, required

## Other responses

- `400` — Bad Request

## Changes

- **2022-11-24** `a67282f76c41` — 2 warning
  - removed the optional property `details/items/status` from the response with the `400` status
  - removed the optional property `issues/details/items/status` from the response with the `200` status
- **2022-11-10** `88d79b1ba69f` — 2 info
  - added the optional property `details/items/status` to the response with the `400` status
  - added the optional property `issues/details/items/status` to the response with the `200` status

[Change history](https://skmtc.dev/shmel1k/apis/yq/changes/queries/:query_id/get.md)

---

[API](https://skmtc.dev/shmel1k/apis/yq.md) · [All operations](https://skmtc.dev/shmel1k/apis/yq/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/shmel1k/yq/revisions/036b0af69dee/schema)