---
title: "Editor canvas (draft)"
method: GET
path: "/dashboards/{dashboard_id}/canvas"
tags: ["Dashboard v3"]
---

# Editor canvas (draft)

`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`

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.

## Path parameters

- `dashboard_id` integer, required

## Query parameters

- `sequence` integer, nullable
- `rls_preview_value` string, nullable

## Response `200`

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

- CanvasResponse
  - `canvas` object, required
  - `plan` object, nullable
  - `specs` object
  - `meta` CanvasMeta, required
    - `sequence` integer, required
    - `signature_token` string, nullable
    - `signature_locked` boolean
    - `artifact_version` string, nullable
    - `filters` object
    - `figures` object
    - `stale_bake` boolean
    - `bake_error` union
      - object
      - string
    - `heal_notes` string[]
    - `unbuilt_notes` string[]
    - `fanout_notes` string[]
    - `unweighted_means` string[]
    - `broken_bindings` object[], nullable
    - `receipts` object
    - `context_drift` object[]
    - `published_context_drift` object[]
    - `context_baseline` boolean, nullable
    - `currency` object, nullable
    - `on_sample_data` boolean
    - `sanctioned_demo_publish` boolean
    - `rls_scoped` boolean
  - `dashboard_id` integer, nullable
  - `unavailable_files` UnavailableFileType[]
    - `id` integer, required
    - `name` string, required

## Other responses

- `400`: Bad request syntax or unsupported method
- `403`: Request forbidden -- authorization will not help

---

[API](https://skmtc.dev/mammoth/apis/mammoth-analytics.md) · [All operations](https://skmtc.dev/mammoth/apis/mammoth-analytics/llms.txt) · [OpenAPI document](https://skmtc.dev/mammoth/apis/mammoth-analytics/revisions/fe078afe239b?raw)