> For clean Markdown of any page, append `.md` to the page URL. > For a complete documentation index, see https://docs.sarvam.ai/llms.txt. > For full documentation content in one file, see https://docs.sarvam.ai/llms-full.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.sarvam.ai/_mcp/server. # Run widget POST https://apps.sarvam.ai/api/analytics/v1/{org_id}/{workspace_id}/boards/{board_id}/widgets/{widget_id}/run Content-Type: application/json Executes the widget's stored SQL with the board's filter defaults, overridden by any `filter_values` supplied here. Results are cached briefly per widget, filter set and row limit; editing the widget invalidates its cache. Safe and side-effect free despite being a POST. Render a whole board by calling this once per widget. Reference: https://docs.sarvam.ai/api-reference/boards/widgets/run ## Request ### Path parameters - `org_id` (string, required) — Organization ID - `workspace_id` (string, required) — Workspace ID - `board_id` (string, required) - `widget_id` (string, required) ### Headers - `X-API-Key` (string, required) — Your workspace API key. ### Body (application/json) This endpoint expects a RunWidgetRequest. - `filter_values` (map from string to FilterValueInput, optional) — Values overriding the filters' stored defaults, keyed by token name - `row_limit` (integer, optional, default: 1000) — Maximum rows returned. Optional — omit it for the default of 1000. A `LIMIT` inside your SQL can narrow the result further but never widens it past this. The result reports `truncated` when this cut the result short. ## Response ### 200 Successful Response - `columns` (list of QueryColumn, required) — Column metadata in result order; position N describes position N of every row - `rows` (list of list of any, required) — Row values as positional arrays aligned 1:1 with `columns`, not keyed objects - `row_count` (integer, required) — Number of rows in `rows`, which is not the total matched when `truncated` - `truncated` (boolean, required) — True when the result was cut short by `row_limit` - `execution_ms` (integer, required) — Query execution time in milliseconds, excluding network transfer ## Errors ### 400 Bad Request Error Invalid SQL, unresolved filter token, or bad filter value - `error` (ErrorBody, required) — Details of the error that occurred. ### 401 Unauthorized Error Missing or invalid credentials - `error` (ErrorBody, required) — Details of the error that occurred. ### 403 Forbidden Error Credentials are not scoped to this org and workspace - `error` (ErrorBody, required) — Details of the error that occurred. ### 404 Not Found Error No such resource in this workspace - `error` (ErrorBody, required) — Details of the error that occurred. ### 408 Request Timeout Error The analytics query exceeded its time budget - `error` (ErrorBody, required) — Details of the error that occurred. ### 422 Unprocessable Entity Error The analytics database rejected the query - `error` (ErrorBody, required) — Details of the error that occurred. ### 429 Too Many Requests Error Rate limit exceeded. Honour the `Retry-After` response header before retrying. - `error` (ErrorBody, required) — Details of the error that occurred. ### 500 Internal Server Error Unexpected server error - `error` (ErrorBody, required) — Details of the error that occurred. ## Types ### FilterValueInput A filter value supplied at run time. Send the filter's declared type alongside the raw string value; Sarvam converts it before binding (a `date`, for example, is parsed and converted to UTC). - `filter_type` (enum, required) - Allowed values: `number`, `string`, `date`, `dropdown` - `value` (string, required) ### QueryColumn - `name` (string, required) — Column name as returned by the query - `type` (string, required) — ClickHouse type name, e.g. `UInt64`, `String`, `DateTime` ### ErrorBody Details of the error that occurred. - `code` (string, required) — A service-specific error code. - `message` (string, required) — A human-readable description of the error. ## Examples **Request** ```json { "filter_values": { "agent_id": { "filter_type": "string", "value": "support-agent-v3" }, "start_date": { "filter_type": "date", "value": "2026-09-01" } }, "row_limit": 500 } ``` **Response** ```json { "columns": [ { "name": "day", "type": "Date" }, { "name": "connected", "type": "UInt64" }, { "name": "total", "type": "UInt64" } ], "rows": [ [ "2026-09-01", 842, 1104 ], [ "2026-09-02", 915, 1187 ] ], "row_count": 2, "truncated": false, "execution_ms": 184 } ``` **SDK Code** ```python import requests url = "https://apps.sarvam.ai/api/analytics/v1/org_id/workspace_id/boards/board_id/widgets/widget_id/run" payload = { "filter_values": { "agent_id": { "filter_type": "string", "value": "support-agent-v3" }, "start_date": { "filter_type": "date", "value": "2026-09-01" } }, "row_limit": 500 } headers = { "X-API-Key": "", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://apps.sarvam.ai/api/analytics/v1/org_id/workspace_id/boards/board_id/widgets/widget_id/run'; const options = { method: 'POST', headers: {'X-API-Key': '', 'Content-Type': 'application/json'}, body: '{"filter_values":{"agent_id":{"filter_type":"string","value":"support-agent-v3"},"start_date":{"filter_type":"date","value":"2026-09-01"}},"row_limit":500}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://apps.sarvam.ai/api/analytics/v1/org_id/workspace_id/boards/board_id/widgets/widget_id/run" payload := strings.NewReader("{\n \"filter_values\": {\n \"agent_id\": {\n \"filter_type\": \"string\",\n \"value\": \"support-agent-v3\"\n },\n \"start_date\": {\n \"filter_type\": \"date\",\n \"value\": \"2026-09-01\"\n }\n },\n \"row_limit\": 500\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("X-API-Key", "") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://apps.sarvam.ai/api/analytics/v1/org_id/workspace_id/boards/board_id/widgets/widget_id/run") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["X-API-Key"] = '' request["Content-Type"] = 'application/json' request.body = "{\n \"filter_values\": {\n \"agent_id\": {\n \"filter_type\": \"string\",\n \"value\": \"support-agent-v3\"\n },\n \"start_date\": {\n \"filter_type\": \"date\",\n \"value\": \"2026-09-01\"\n }\n },\n \"row_limit\": 500\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://apps.sarvam.ai/api/analytics/v1/org_id/workspace_id/boards/board_id/widgets/widget_id/run") .header("X-API-Key", "") .header("Content-Type", "application/json") .body("{\n \"filter_values\": {\n \"agent_id\": {\n \"filter_type\": \"string\",\n \"value\": \"support-agent-v3\"\n },\n \"start_date\": {\n \"filter_type\": \"date\",\n \"value\": \"2026-09-01\"\n }\n },\n \"row_limit\": 500\n}") .asString(); ``` ```php request('POST', 'https://apps.sarvam.ai/api/analytics/v1/org_id/workspace_id/boards/board_id/widgets/widget_id/run', [ 'body' => '{ "filter_values": { "agent_id": { "filter_type": "string", "value": "support-agent-v3" }, "start_date": { "filter_type": "date", "value": "2026-09-01" } }, "row_limit": 500 }', 'headers' => [ 'Content-Type' => 'application/json', 'X-API-Key' => '', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://apps.sarvam.ai/api/analytics/v1/org_id/workspace_id/boards/board_id/widgets/widget_id/run"); var request = new RestRequest(Method.POST); request.AddHeader("X-API-Key", ""); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"filter_values\": {\n \"agent_id\": {\n \"filter_type\": \"string\",\n \"value\": \"support-agent-v3\"\n },\n \"start_date\": {\n \"filter_type\": \"date\",\n \"value\": \"2026-09-01\"\n }\n },\n \"row_limit\": 500\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "X-API-Key": "", "Content-Type": "application/json" ] let parameters = [ "filter_values": [ "agent_id": [ "filter_type": "string", "value": "support-agent-v3" ], "start_date": [ "filter_type": "date", "value": "2026-09-01" ] ], "row_limit": 500 ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://apps.sarvam.ai/api/analytics/v1/org_id/workspace_id/boards/board_id/widgets/widget_id/run")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```