Skip to main content

Dashboards & Reports

Configurable dashboards with widgets, plus aggregate reporting endpoints. All endpoints require a valid Bearer JWT and are scoped to the token's project_id.

Dashboards​

MethodPathDescription
GET/api/dashboardsList dashboards.
GET/api/dashboards/{id}Fetch a dashboard.
POST/api/dashboardsCreate a dashboard.
PUT/api/dashboards/{id}Update a dashboard.
DELETE/api/dashboards/{id}Delete a dashboard.

Widgets​

MethodPathDescription
POST/api/dashboards/{id}/widgetsAdd a widget to a dashboard.
PUT/api/dashboards/{dashboard_id}/widgets/{widget_id}Update a widget.
PUT/api/dashboards/{id}/widgets/layoutUpdate the widget layout.
DELETE/api/dashboards/{dashboard_id}/widgets/{widget_id}Delete a widget.
GET/api/widget-templatesList available widget templates.
GET/api/widgets/{widget_type}/{widget_key}/dataFetch data for a widget.

Reports​

MethodPathDescription
GET/api/reports/metricsAggregate metrics.
POST/api/reports/activityActivity report.
POST/api/v2/reports/activityActivity report (v2).
POST/api/reports/callsCalls report.