canvases

Everything needed to open the canvas, in one round trip.

Returns the record, the live build (with its signed artifact URL), and — only when there is nothing built to render — the head source project (freeform/component) or the layout document (grid). Send the response's ETag back as If-None-Match to revalidate without a body.

get/api/projects/{project_id}/canvases/{id}/view/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/canvases/{id}/view/
  • Auth: HTTP bearer

Path parameters

idstring uuid required

A UUID string identifying this canvas.

project_idstring required

Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Response

current_version_idstring nullable required

Id of the source version the canvas's head points at. Null before the first publish.

has_active_buildboolean required

True while a build is queued or running — poll the builds endpoint until it settles.

sandbox_document_urlstring nullable required

URL of the sandbox document that renders the head source project in an iframe, served from the artifact origin. Load it by URL, not as srcdoc. Null when artifact delivery is unavailable.

Changes

No recorded changes to this operation across all 1 revision of this API.