Run tab | Sarvam API Docs

import requests
url = "https://apps.sarvam.ai/api/analytics/v1/org_id/workspace_id/boards/0b7f2c9a-5e41-4d2a-9f3b-8c1d6e7a0b52/tabs/6d1e84b3-9c07-4f52-b8ad-2e5f70c94a18/run"
payload = { "filter_values": { "start_date": {
            "filter_type": "date",
            "value": "2026-09-01T00:00:00+05:30"
        } } }
headers = {
    "X-API-Key": "<your-api-key>",
    "Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

{
  "results": [
    {
      "status": "ok",
      "columns": [
        {
          "name": "day",
          "type": "Date"
        },
        {
          "name": "connected",
          "type": "UInt64"
        },
        {
          "name": "total",
          "type": "UInt64"
        }
      ],
      "execution_ms": 184,
      "row_count": 2,
      "rows": [
        [
          "2026-09-01",
          842,
          1104
        ],
        [
          "2026-09-02",
          915,
          1187
        ]
      ],
      "truncated": false,
      "widget_id": "a4c9e0f7-31b8-4d6a-9e25-7f0b3c81d46e"
    },
    {
      "status": "error",
      "error": {
        "code": "TIMEOUT",
        "message": "Query exceeded its 15s time budget."
      },
      "widget_id": "c8b1d5a2-7e34-4902-8f6d-1a3b9c05e7f2"
    }
  ],
  "filter_values_used": {
    "agent_id": null,
    "start_date": "2026-09-01T00:00:00+05:30"
  }
}

Runs every widget on the tab in one call and returns one result per widget. Each result has status ok or error, so one failing widget doesn’t fail the request. Side-effect free despite being a POST.

Path parameters

org_idstringRequired

Organization ID

workspace_idstringRequired

Workspace ID

board_idstringRequiredformat: "uuid"

Board ID, as returned in id by Create board or List boards. Must be a UUID; anything else is rejected with 422.

tab_idstringRequiredformat: "uuid"

Tab ID, from the board’s tabs in Get board. Must be a UUID; anything else is rejected with 422.

Request

This endpoint expects an object.

filter_valuesmap from strings to objectsOptional

Values overriding the filters' stored defaults, keyed by token name. Values for tokens the board has no filter for are ignored.

Response

Successful Response

resultslist of objects

One entry per widget on the tab, each tagged ok or error by status

filter_values_usedmap from strings to nullable strings

The filter values applied, after merging your values with the defaults. A value is null when the filter had no value and no default.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

408

Request Timeout Error

422

Unprocessable Entity Error

429

Too Many Requests Error

500

Internal Server Error

Path parameters

Headers

Request

Response

Errors