Skip to content
XOS Developers

dashboards

Reports module · 5 operations

List dashboard rows

GET/dashboards

A grid of report tiles, saved per user or per team. Returns a cursor page of dashboard rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.

Create a dashboard

POST/dashboards

A grid of report tiles, saved per user or per team. Creates a dashboard. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

Get a dashboard

GET/dashboards/{id}

A grid of report tiles, saved per user or per team. Returns one dashboard with its `ETag`. A dashboard the caller may not see returns 404.

Update a dashboard

PATCH/dashboards/{id}

A grid of report tiles, saved per user or per team. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.

Delete a dashboard

DELETE/dashboards/{id}

A grid of report tiles, saved per user or per team. Soft-deletes the dashboard: it moves to Trash and can be restored for its table's retention period.