MOmoda
canvas-actions

Read Canvas State Summary

Changed on

Structural summary of the canvas: page index + node counts, no DSL payload.

The cheap-to-consume sibling of GET .../state (whose DSL can run to hundreds of KB on big canvases). Computed from the SAME projection as the full read — same optimizer chain, same per-page node reachability counts — and it counts as a read for revision-pin purposes: revision is the same read-lane token the full read returns, safe to pin as expected_revision. Page ids are the same session-scoped p_* short refs the full read mints (the mapping table is persisted), so they round-trip into the write verbs.

get/canvases/{canvas_ref}/state/summary

Request

  • Base URL
    https://api.moda.app/v1
  • URL
    https://api.moda.app/v1/canvases/{canvas_ref}/state/summary
  • Auth
    HTTP bearer

Path parameters

canvas_refstring required

Headers

Moda-Version'2026-04-12' | '2026-05-01'
Example:2026-05-01

Calendar-dated API version pin. New integrations should pin 2026-05-01 to opt into the newest response shapes. For back-compat the server also accepts requests with no header and resolves them to the current default (today: 2026-04-12); that default advances on each sunset date. Any unsupported value returns 400 unsupported_version.

Response

Successful Response

object required

Changes