Skip to main content
POST
/
analytics
/
query
Run analytics query
curl --request POST \
  --url https://api.hexclave.com/api/v1/analytics/query \
  --header 'Content-Type: application/json' \
  --data '
{
  "include_all_branches": false,
  "query": "SELECT count() AS event_count FROM events",
  "params": {
    "event_type": "$page-view"
  },
  "timeout_ms": 10000
}
'
{
  "result": [
    {
      "event_count": 42
    }
  ],
  "query_id": "00000000-0000-0000-0000-000000000000:main:00000000-0000-0000-0000-000000000001"
}

Body

application/json
​
query
string
required

A read-only ClickHouse SQL query.

Example:

"SELECT count() AS event_count FROM events"

​
include_all_branches
boolean
default:false

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

Example:

false

​
params
object

ClickHouse query parameters referenced by the query.

Example:
{ "event_type": "$page-view" }
​
timeout_ms
integer
default:10000

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

Example:

10000

Response

200 - application/json

Successful response

​
result
object[]
required

Query result rows as plain JSON objects.

Example:
[{ "event_count": 42 }]
​
query_id
string
required

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

Example:

"00000000-0000-0000-0000-000000000000:main:00000000-0000-0000-0000-000000000001"