Update Widget

Update a dashboard widget.

put/analytics/widgets/{widget_id}

Path parameters

widget_idstring required

Headers

TENANTstring required

The tenant you are making this request on behalf of

API-KEYstring required

Your api key

Request body

titlestring nullable

Title of the widget

descriptionstring nullable

Description of the widget

chartTypestring nullable

Type of chart

chartConfigobject nullable

Chart-specific configuration

layoutPositionobject nullable

Grid position and size

isArchivedboolean nullable

Whether the widget is archived

orderIndexinteger nullable

Order index for widget positioning

Response

Successful Response

idstring required

Unique identifier for the widget

dashboardIdstring required

ID of the dashboard this widget belongs to

titlestring required

Title of the widget

descriptionstring nullable

Description of the widget

chartTypestring required

Type of chart

chartConfigobject nullable

Chart-specific configuration

layoutPositionobject required

Grid position and size

isArchivedboolean required

Whether the widget is archived

orderIndexinteger required

Order index for widget positioning

createdDatestring date-time required

When the widget was created

updatedDatestring date-time nullable

When the widget was last updated

Changes

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