Sign in

v4

latestOpenAPI 3.1.02026-08-019681,1012.0 MB
custom_dashboards

Create Widget

post/custom_dashboards/{dashboard_id}/widgets

Path parameters

dashboard_idstring uuid4 required

Request body

namestring required
descriptionstring nullable
type'bar_chart' | 'line_chart' | 'number' | 'table' required
datasetobject[] nullable
metricstring required
aggregation'Count' | 'Sum' | 'Average' | 'Min' | 'Max' | 'P50' | 'P90' | 'P95' | 'P99' | 'PercentageFalse' | 'PercentageTrue' required
section_idstring uuid4 nullable
analysis_mode'compare' | 'combine'

Response

Successful Response

idstring uuid4 required
namestring required
descriptionstring nullable
type'bar_chart' | 'line_chart' | 'number' | 'table' required
datasetobject[] nullable
metricstring required
aggregation'Count' | 'Sum' | 'Average' | 'Min' | 'Max' | 'P50' | 'P90' | 'P95' | 'P99' | 'PercentageFalse' | 'PercentageTrue' required
section_idstring uuid4 nullable
analysis_mode'compare' | 'combine'