Start free trial

Add a widget

POST/api/v1/dashboards/{dashboard_id}/widgets

Add a widget from a chat card ('Add to dashboard') or manually. The snapshot payload is stored verbatim; a source tool, when provided, must be a READ tool.

Operation ID: add_widget_api_v1_dashboards__dashboard_id__widgets_post·View as markdown·OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Path

dashboard_idstringrequired

Request body

Schema: AddWidgetRequest

titlestringrequired
widget_typestringrequired

One of: chart, table, metric, text

layoutWidgetLayout
sourceWidgetSource
snapshotWidgetSnapshot
bodystring

Responses

201Successful Response

Schema: SuccessEnvelope_DashboardResponse_

successboolean
messagestring
codestring
dataDashboardResponse

400Bad Request - Invalid input

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

404Not Found - Resource does not exist

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError
5 fields
locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject