Update widget

PATCH

https://apps.sarvam.ai/api/analytics/v1/:org_id/:workspace_id/boards/:board_id/widgets/:widget_id

PATCH

/api/analytics/v1/:org_id/:workspace_id/boards/:board_id/widgets/:widget_id

import requests
url = "https://apps.sarvam.ai/api/analytics/v1/org_id/workspace_id/boards/board_id/widgets/widget_id"
payload = {
    "name": "Daily connected calls (7d)",
    "viz_type": "bar"
}
headers = {
    "X-API-Key": "<your-api-key>",
    "Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.json())

{
  "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"
}

Partial update. Changing sql revalidates it, re-derives the board’s filter tokens, and invalidates any cached result for this widget.

Path parameters

org_idstringRequired

Organization ID

workspace_idstringRequired

Workspace ID

board_idstringRequiredformat: "uuid"

widget_idstringRequiredformat: "uuid"

Request

This endpoint expects an object.

namestring or nullOptional1-60 characters

New display name

sqlstring or nullOptional>=1 character

Replacement SQL; same token syntax as on create

viz_typeenum or nullOptional

New renderer

viz_configobject or nullOptional

Replacement renderer options

Response

Successful Response

idstringformat: "uuid"

Widget identifier

board_idstringformat: "uuid"

Board this widget belongs to

namestring

Widget display name

sqlstring

The widget's stored SQL, filter tokens unexpanded

viz_typestring

How the result is rendered

viz_configobject

Renderer options for viz_type

created_byobject

Actor that created the widget

created_atdatetime

Creation time, UTC, RFC 3339

updated_byobject

Actor that last changed the widget

updated_atdatetime

Last change time, UTC, RFC 3339

Errors

400

Bad Request Error

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

Request

Response

Errors