Sign in
dashboards

Create Widget From Template

Instantiate a library template onto a dashboard (copy-on-instantiate, PR10).

Copies the template's config onto a new widget with a frozen source_config_snapshot baseline. template_ref is a system registry key or a UserWidgetTemplate id.

post/api/v1/dashboards/{dashboard_id}/widgets/from-template

Path parameters

dashboard_idstring uuid required

Request body

template_refstring required
positionobject nullable

Response

Successful Response

idstring uuid required
dashboard_idstring uuid required
titlestring required
viz_type'line' | 'bar' | 'pie' | 'number' | 'pivot' | 'logs_table' | 'heatmap' required
configobject required
positionobject required
is_systemboolean
source_kind'system' | 'user' nullable
source_refstring nullable
source_config_snapshotobject nullable
source_viz_snapshot'line' | 'bar' | 'pie' | 'number' | 'pivot' | 'logs_table' | 'heatmap'
created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this endpoint across all 1 revision of this API.