コンテンツにスキップ

Execute an analytics query

POST
/v1/query

Execute a SQL-like analytics query against telemetry data stored in ClickHouse. Only SELECT statements are allowed. Queries are validated, rewritten to enforce tenant isolation, and executed against a read-only connection.

object
project_id
required

The project ID to query.

string format: uuid
sql
required

SQL query (SELECT only).

string
limit

Maximum number of rows to return.

integer
default: 1000 >= 1 <= 10000

Query results.

object
success
boolean
data

Response payload (varies by endpoint).

X-RateLimit-Limit
integer

Maximum number of requests allowed per hour.

X-RateLimit-Remaining
integer

Number of requests remaining in the current window.

X-RateLimit-Reset
integer

Unix timestamp when the rate limit window resets.

Invalid request parameters or body.

object
success
boolean
error

Human-readable error message.

string

Missing or invalid API key.

object
success
boolean
error

Human-readable error message.

string

Rate limit exceeded.

object
success
boolean
error

Human-readable error message.

string
X-RateLimit-Limit
integer

Maximum number of requests allowed per hour.

X-RateLimit-Remaining
integer

Number of requests remaining in the current window.

X-RateLimit-Reset
integer

Unix timestamp when the rate limit window resets.

Query execution failed.

object
success
boolean
error

Human-readable error message.

string