api reference

Widgets

Tiles placed on a dashboard — either a visualization or a text block.

POST/api/widgets

Add a widget to a dashboard. Set visualization_id for a chart/table tile, or text for a markdown text tile; width defaults to 1.

Request

{ "dashboard_id": 9, "visualization_id": 71, "width": 2, "options": {} }

Response

{
  "id": 200,
  "dashboard_id": 9,
  "visualization_id": 71,
  "text": null,
  "width": 2,
  "options": {},
  "created_at": "2026-07-17T12:00:00Z",
  "updated_at": "2026-07-17T12:00:00Z"
}

POST/api/widgets/{id}

Update a widget's text, width, or options.

Request

{ "width": 3 }

DELETE/api/widgets/{id}

Remove a widget from its dashboard. Returns 204.