List Widgets

List dashboard widgets with optional filtering.

get/analytics/widgets

Query parameters

pageinteger nullable

per_pageinteger nullable

sort_bystring nullable

sort_direction'asc' | 'desc' nullable

location_idstring nullable

dashboard_idstring nullable

Filter by dashboard ID

chart_typestring nullable

Filter by chart type

is_archivedboolean nullable

Filter by archived status

TENANTstring required

The tenant you are making this request on behalf of

API-KEYstring required

Your api key

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

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