v3

latestOpenAPI 3.1.02026-07-311,4541,5202.3 MB
clickhouse

Sql Queries Create

Execute a SQL query against the organization's ClickHouse data.

POST /clickhouse/sql-queries/ { "query": "SELECT model, count(*) as cnt FROM logs GROUP BY model ORDER BY cnt DESC", "parameters": {} // reserved for future ClickHouse parameterized query support }

Returns: { "columns": ["model", "cnt"], "rows": [["gpt-4", 150], ["claude-3", 120], ...], "row_count": 25, "execution_time_ms": 342 }

post/clickhouse/sql-queries/

Headers

Authorizationstring required

JWT access token or Respan API key

Request body

querystring required

ClickHouse SQL query. Only SELECT statements allowed.

start_timestring date-time

Optional. Bound into {{ start_time }} references.

end_timestring date-time

Optional. Bound into {{ end_time }} references. Must be after start_time when both are set.

environment'all' | 'prod' | 'test'
  • all - all
  • prod - prod
  • test - test
filtersobject

Optional dashboard filters for saved SQL queries that opt in.

Response

columnsstring[] required

Column names in the result set.

row_countinteger required

Number of rows returned.

execution_time_msinteger required

Server-side query execution time in milliseconds.

warningsobject[]

Non-fatal dashboard filter warnings.