Dashboard v3

Editor canvas (draft)

The draft canvas + baked plan/specs for the editor — static, no data. Pass sequence for a specific version, and rls_preview_value while 'Viewing as' a scoped viewer so the payload is redacted exactly as that viewer's would be.

get/dashboards/{dashboard_id}/canvas

Request

  • Base URL: https://app.mammoth.io/api/v2
  • URL: https://app.mammoth.io/api/v2/dashboards/{dashboard_id}/canvas
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-KEY and API key in header X-API-SECRET and API key in header X-WORKSPACE-ID

Path parameters

dashboard_idinteger required

Query parameters

sequenceinteger nullable
rls_preview_valuestring nullable

Response

Canvas + baked plan/specs (no data, no RLS resolution)

canvasobject required
planobject nullable
specsobject
dashboard_idinteger nullable

Changes

No recorded changes to this operation across all 4 revisions of this API.