Dashboards

Read-only dashboard listing, fetching, and PDF export.

Read-only for now: only listing, fetching, and PDF export are available. Create/update/delete aren't exposed yet, and the dashboard's layout/widget spec is not included in the response — see components.schemas.Dashboard in the API Reference, or Field Reference, for the exact field set.

GET /dashboards · GET /dashboards/:dashboardId

{
  "id": "7da90812bfd640fab5c216963291650c",
  "name": "Exec Overview",
  "ownerUserId": "f22930a78dd34af185b53aa3f97e11ff",
  "createdAt": "2026-03-01T00:00:00.000Z",
  "updatedAt": "2026-03-15T00:00:00.000Z",
  "version": "1.0"
}

POST /dashboards/:dashboardId/export

Render the dashboard as a PDF. Returns the binary document with Content-Type: application/pdf (and a Content-Disposition attachment header) — not JSON.


Did this page help you?