Analyze — API reference

Custom dashboards, the metrics catalogue, and saved analyses.

dashboards

GET /dashboards

List Dashboards

POST /dashboards

Create Dashboard

GET /dashboards/by-slug/{slug}

Get Dashboard By Slug

Resolve a dashboard by its stable slug within the caller’s tenant.

GET /dashboards/favorites

List Favorites

The caller’s favorited dashboards.

POST /dashboards/favorites/{dash_id}

Add Favorite

DELETE /dashboards/favorites/{dash_id}

Remove Favorite

GET /dashboards/{dash_id}

Get Dashboard

PATCH /dashboards/{dash_id}

Update Dashboard

DELETE /dashboards/{dash_id}

Delete Dashboard

POST /dashboards/{dash_id}/clone

Clone Dashboard

Deep-clone a dashboard the caller can see into a fresh private copy they own.

POST /dashboards/{dash_id}/widgets

Add Widget

POST /dashboards/{dash_id}/widgets/reorder

Reorder Widgets

Persist a new widget display order.

PATCH /dashboards/{dash_id}/widgets/{wid}

Update Widget

DELETE /dashboards/{dash_id}/widgets/{wid}

Delete Widget

POST /dashboards/{dash_id}/widgets/{wid}/clone

Clone Widget

Duplicate a widget within the same dashboard (config + color preserved).

GET /dashboards/{dash_id}/widgets/{wid}/data

Widget Data

Resolve a widget’s data LIVE via run_measure — the render-time data fetch.

GET /measures/catalogue

Measure Catalogue

The measure catalogue: each measure + the dimensions valid for it + the widget types.

GET /measures/fields

Measures Fields

Discover dynamic, sliceable session.metadata.* keys for the current scope.

analyses

POST /analyses/{name}/run

Run Analysis