Export the result of a read-only ClickHouse query

Runs one SELECT against the activity log tables (the same guarded runner as the app's SQL editor: read-only, per-table read permissions, environment row policies, 10s and 1000-row caps). Requires dashboard:RunCustomQuery. {environmentId} and {timezone} are available as bound variables.

Request body (optional)

sqlstringrequired

formatenum

jsonndjsoncsvxlsx

filenamestring

Responses

200Query rows in the requested format

dataobject[]required

columnsstring[]required

400Invalid or non-read-only SQL

403Insufficient permissions

Sending requests from a browser

Open https://v3.revolutionstreetwxs.io/api/v3/docs to send requests to this endpoint with your API key.

Request

curl -X POST 'https://v3.revolutionstreetwxs.io/api/v3/export/sql' \
  -H "Authorization: Bearer wxs_pk_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "sql": "SELECT toStartOfDay(created_at, {timezone}) AS day, count() AS picks FROM pick_put_logs GROUP BY day ORDER BY day",
  "format": "json",
  "filename": "filename"
}'

const response = await fetch("https://v3.revolutionstreetwxs.io/api/v3/export/sql", {
  method: "POST",
  headers: {
    Authorization: "Bearer wxs_pk_YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "sql": "SELECT toStartOfDay(created_at, {timezone}) AS day, count() AS picks FROM pick_put_logs GROUP BY day ORDER BY day",
    "format": "json",
    "filename": "filename"
  }),
});
const data = await response.json();

import requests

response = requests.post(
    "https://v3.revolutionstreetwxs.io/api/v3/export/sql",
    headers={"Authorization": "Bearer wxs_pk_YOUR_API_KEY"},
    json={
      "sql": "SELECT toStartOfDay(created_at, {timezone}) AS day, count() AS picks FROM pick_put_logs GROUP BY day ORDER BY day",
      "format": "json",
      "filename": "filename"
    },
)
data = response.json()

Response 200

{
  "data": [
    {}
  ],
  "columns": [
    "column"
  ]
}