---
title: "Run analytics query"
method: POST
path: "/analytics/query"
tags: ["Analytics"]
---

# Run analytics query

`POST /analytics/query`

Runs a read-only ClickHouse SQL query against the current project's analytics dataset.

## Request body

- object
  - `include_all_branches` boolean — Reserved for future branch-wide analytics queries. Must be false.
  - `query` string, required — A read-only ClickHouse SQL query.
  - `params` object — ClickHouse query parameters referenced by the query.
  - `timeout_ms` integer — Maximum query execution time in milliseconds. The effective timeout is also capped by the project's plan.

## Response `200`

Successful response

- object
  - `result` object[], required — Query result rows as plain JSON objects.
  - `query_id` string, required — The ClickHouse query ID. Use it to fetch query timing stats.

---

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