Run tab

POST

https://apps.sarvam.ai/api/analytics/v1/:org_id/:workspace_id/boards/:board_id/tabs/:tab_id/run

POST

/api/analytics/v1/:org_id/:workspace_id/boards/:board_id/tabs/:tab_id/run

import requests
url = "https://apps.sarvam.ai/api/analytics/v1/org_id/workspace_id/boards/board_id/tabs/tab_id/run"
payload = { "filter_values": { "start_date": {
            "filter_type": "date",
            "value": "2026-09-01"
        } } }
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-01"
  }
}

Runs the tab’s widgets together and returns one result per widget, so rendering a tab costs a single call rather than one per widget. Widgets execute concurrently and each is reported as ok or error by its status: a widget that fails does not fail the request, so one broken query cannot hide the rest of the tab. Safe and side-effect free despite being a POST. The tab, not the board, is the unit here — there is no whole-board run.

Runs the tab's widgets together and returns one result per widget, so rendering a tab costs a single call rather than one per widget. Widgets execute concurrently and each is reported as `ok` or `error` by its `status`: a widget that fails does not fail the request, so one broken query cannot hide the rest of the tab. Safe and side-effect free despite being a POST. The tab, not the board, is the unit here — there is no whole-board run.

Path parameters

org_idstringRequired

Organization ID

workspace_idstringRequired

Workspace ID

board_idstringRequiredformat: "uuid"

tab_idstringRequiredformat: "uuid"

Request

This endpoint expects an object.

filter_valuesmap from strings to objectsOptional

Values overriding the filters' stored defaults, keyed by token name

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 actually applied, after merging the request with each filter's 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