Preview query | Sarvam API Docs

import requests
url = "https://apps.sarvam.ai/api/analytics/v1/org_id/workspace_id/query-preview"
payload = {
    "sql": "SELECT language_name, count() AS calls
FROM EngagementFactsBoardsView
WHERE effective_datetime >= {{start_date}}
GROUP BY language_name
ORDER BY calls DESC",
    "filter_values": { "start_date": {
            "filter_type": "date",
            "value": "2026-09-01T00:00:00+05:30"
        } },
    "row_limit": 100
}
headers = {
    "X-API-Key": "<your-api-key>",
    "Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

{
  "columns": [
    {
      "name": "language_name",
      "type": "LowCardinality(String)"
    },
    {
      "name": "calls",
      "type": "UInt64"
    }
  ],
  "rows": [
    [
      "Hindi",
      1842
    ],
    [
      "English",
      1109
    ],
    [
      "Tamil",
      402
    ]
  ],
  "row_count": 3,
  "truncated": false,
  "execution_ms": 96
}

Runs read-only SQL against the workspace’s analytics views without saving a widget. Use it to develop a query. Side-effect free despite being a POST.

Path parameters

org_idstringRequired

Organization ID

workspace_idstringRequired

Workspace ID

Request

This endpoint expects an object.

sqlstringRequired>=1 character

Read-only SELECT; same filter-token syntax as widget SQL

filter_valuesmap from strings to objectsOptional

Values for the tokens in sql, keyed by token name. Preview has no board, so there are no defaults: every token outside an optional [[...]] block needs a value here.

row_limitintegerOptional1-10000Defaults to 1000

Maximum rows, 1–10000. Default 1000. A LIMIT in your SQL also applies and is capped at 1000.

Response

Successful Response

columnslist of objects

Column metadata in result order; position N describes position N of every row

rowslist of lists of any

Row values as positional arrays aligned 1:1 with columns, not keyed objects

row_countinteger

Number of rows in rows, which is not the total matched when truncated

truncatedboolean

True when the rows returned reached the row limit, so the result may have been cut. Also true when your own LIMIT is reached exactly.

execution_msinteger

Query execution time in milliseconds, excluding network transfer

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

408

Request Timeout Error

422

Unprocessable Entity Error

429

Too Many Requests Error

500

Internal Server Error

Path parameters

Headers

Request

Response

Errors