Skip to main content
POST
Create a dashboard widget

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Body for creating a widget on a dashboard.

Unlike the other create bodies, spec is deep-validated here: it is a structured contract the agent/CLI must compose (a wrong shape only surfaces at render time otherwise), and the union below is what generated tool schemas show the model.

dashboard_id
string
required
project_id
string
required
spec
WidgetSpec (spans) · object
required

Chart spec over the "spans" view; the enums below are the complete field vocabulary for this view.

title
string
required
type
string
required
display_config
Display Config · object | null

Response

Successful Response

The created widget (widget creation is strict, never idempotent).

created
boolean
required
dashboard_id
string
required
id
string
required
title
string
required
type
string
required