Get query schema | Sarvam API Docs

import requests
url = "https://apps.sarvam.ai/api/analytics/v1/org_id/workspace_id/query-schema"
headers = {"X-API-Key": "<your-api-key>"}
response = requests.get(url, headers=headers)
print(response.json())

{
  "tables": [
    {
      "name": "EngagementFactsBoardsView",
      "columns": [
        {
          "name": "interaction_id",
          "type": "String"
        },
        {
          "name": "app_id",
          "type": "String"
        },
        {
          "name": "effective_datetime",
          "type": "DateTime"
        },
        {
          "name": "v2v_connectivity_status",
          "type": "LowCardinality(String)"
        },
        {
          "name": "completion_status",
          "type": "LowCardinality(String)"
        },
        {
          "name": "language_name",
          "type": "LowCardinality(String)"
        },
        {
          "name": "num_messages",
          "type": "UInt32"
        },
        {
          "name": "audio_duration",
          "type": "Nullable(Float32)"
        }
      ]
    }
  ]
}

Returns the analytics tables this workspace may query, each with its columns. Use it to discover table and column names before writing widget SQL. The catalog is the same for every board in the workspace.

Path parameters

org_idstringRequired

Organization ID

workspace_idstringRequired

Workspace ID

Response

Successful Response

tableslist of objects

Queryable tables, each with its columns

Errors

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error

429

Too Many Requests Error

500

Internal Server Error

Path parameters

Headers

Response

Errors