Get board | Sarvam API Docs

import requests
url = "https://apps.sarvam.ai/api/analytics/v1/org_id/workspace_id/boards/0b7f2c9a-5e41-4d2a-9f3b-8c1d6e7a0b52"
headers = {"X-API-Key": "<your-api-key>"}
response = requests.get(url, headers=headers)
print(response.json())

{
  "id": "0b7f2c9a-5e41-4d2a-9f3b-8c1d6e7a0b52",
  "name": "Campaign Overview",
  "created_by": {
    "type": "api_key",
    "id": "sk_live_a1b2c3"
  },
  "created_at": "2026-09-01T09:15:00Z",
  "updated_by": {
    "type": "user",
    "id": "usr_8f21c4d0"
  },
  "updated_at": "2026-09-12T11:42:08Z",
  "tabs": [
    {
      "id": "6d1e84b3-9c07-4f52-b8ad-2e5f70c94a18",
      "name": "Connectivity",
      "position": 0,
      "widgets": [
        {
          "id": "a4c9e0f7-31b8-4d6a-9e25-7f0b3c81d46e",
          "board_id": "0b7f2c9a-5e41-4d2a-9f3b-8c1d6e7a0b52",
          "name": "Daily connected calls",
          "sql": "SELECT\n  toDate(effective_datetime) AS day,\n  countIf(v2v_connectivity_status = 'connected') AS connected,\n  count() AS total\nFROM EngagementFactsBoardsView\nWHERE effective_datetime >= {{start_date}}\n  [[AND app_id = {{agent_id}}]]\nGROUP BY day\nORDER BY day",
          "viz_type": "line",
          "viz_config": {
            "x_axis": "day",
            "y_axis": [
              "connected",
              "total"
            ]
          },
          "created_by": {
            "type": "api_key",
            "id": "sk_live_a1b2c3"
          },
          "created_at": "2026-09-01T09:22:31Z",
          "updated_by": {
            "type": "api_key",
            "id": "sk_live_a1b2c3"
          },
          "updated_at": "2026-09-10T14:03:55Z"
        },
        {
          "id": "c8b1d5a2-7e34-4902-8f6d-1a3b9c05e7f2",
          "board_id": "0b7f2c9a-5e41-4d2a-9f3b-8c1d6e7a0b52",
          "name": "Calls by language",
          "sql": "SELECT language_name, count() AS calls\nFROM EngagementFactsBoardsView\nWHERE effective_datetime >= {{start_date}}\nGROUP BY language_name\nORDER BY calls DESC",
          "viz_type": "bar",
          "viz_config": {
            "x_axis": "language_name",
            "y_axis": [
              "calls"
            ]
          },
          "created_by": {
            "type": "api_key",
            "id": "sk_live_a1b2c3"
          },
          "created_at": "2026-09-01T09:25:10Z",
          "updated_by": {
            "type": "api_key",
            "id": "sk_live_a1b2c3"
          },
          "updated_at": "2026-09-01T09:25:10Z"
        }
      ]
    }
  ],
  "filters": [
    {
      "id": "f2a70c48-5b93-4e16-8d7a-0c4e19b6f235",
      "internal_name": "start_date",
      "display_label": "Start date",
      "filter_type": "date",
      "is_required": true,
      "default_value": "2026-09-01T00:00:00+05:30",
      "dropdown_options": null
    },
    {
      "id": "7b3d9e52-1c84-4a6f-b0e7-93d5f2a1c860",
      "internal_name": "agent_id",
      "display_label": "Agent",
      "filter_type": "string",
      "is_required": false,
      "default_value": null,
      "dropdown_options": null
    }
  ],
  "tag": "Weekly reporting"
}

Returns the whole board: its tabs in position order with their widgets, and its filters.

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.

Response

Successful Response

idstringformat: "uuid"

Board identifier, used as {board_id} in every nested route

namestring

Board display name

created_byobject

Actor that created the board

created_atdatetime

Creation time, UTC, RFC 3339

updated_byobject

Actor that last changed the board or anything on it

updated_atdatetime

Last change time, UTC, RFC 3339

tabslist of objects

The board's tabs in position order, each with its widgets nested

filterslist of objects

Every filter token declared by this board's widgets, in display order

tagstring or nullOptional

The board's grouping tag, or null when untagged

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

429

Too Many Requests Error

500

Internal Server Error

Path parameters

Headers

Response

Errors