Sign in
Widgets

List Widgets

List all widgets in the organization (with their metrics), newest first.

get/v1/widgets

Query parameters

data_type'observability' | 'simulation' nullable

Headers

X-API-Keystring required

API key required to authenticate requests.

Response

Successful Response

idstring required
organization_idstring nullable
namestring required
descriptionstring nullable
chart_typestring required
chart_modestring nullable
data_typestring required
applies_to_all_agentsboolean
bar_modestring nullable
aggregationstring[] nullable
time_bucketstring nullable
group_bystring nullable
simulation_idsinteger[] nullable
show_indeterminateboolean nullable
{"stackTrail":"components:schemas:WidgetModel:properties:filters:anyOf","oasType":"schema","type":"unknown","title":"Filters","description":"Extra conversation filters applied on top of the dashboard scope","nullable":true}
{"stackTrail":"components:schemas:WidgetModel:properties:column_visibility:anyOf","oasType":"schema","type":"unknown","title":"Column Visibility","description":"Table (observability) widgets only: column visibility map","nullable":true}
color_overridesobject nullable

The colour the chart draws each series or slice in, keyed by its label lowercased. Written whole when a widget is saved, so it names every label rather than only the ones a person changed.

show_legendboolean

Whether the chart draws its colour key

created_bystring nullable
created_atstring nullable
updated_atstring nullable

Changes