HEhexclave
Analytics

Run analytics query

Changed on

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

post/analytics/query

Request

  • Base URL
    https://api.hexclave.com/api/v1
  • URL
    https://api.hexclave.com/api/v1/analytics/query
  • Auth
    none declared

Request body

include_all_branchesboolean

Reserved for future branch-wide analytics queries. Must be false.

querystring required

A read-only ClickHouse SQL query.

paramsobject

ClickHouse query parameters referenced by the query.

timeout_msinteger

Maximum query execution time in milliseconds. The effective timeout is also capped by the project's plan.

Example request

{
  "include_all_branches": false,
  "query": "SELECT count() AS event_count FROM events",
  "params": {
    "event_type": "$page-view"
  },
  "timeout_ms": 10000
}

Response

Successful response

resultobject[] required

Query result rows as plain JSON objects.

query_idstring required

The ClickHouse query ID. Use it to fetch query timing stats.

Example response

{
  "result": [
    {
      "event_count": 42
    }
  ],
  "query_id": "00000000-0000-0000-0000-000000000000:main:00000000-0000-0000-0000-000000000001"
}

Changes