canvases

Read the canvas's build lifecycle: live pointers plus recent builds.

A publish queues a build; poll this until it is ready (the live pointer advances) or failed (fix the error diagnostics and publish again — the last good build stays live). Send the response's ETag back as If-None-Match to make the poll revalidate without a body.

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

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/canvases/{id}/builds/
  • 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/.

Query parameters

scopestring

"slim" returns only what rendering needs — the live build, the head version's builds, and anything still in flight — instead of the full recent-build history. Any other value (or none) returns the full window.

version_idstring uuid

Include the retained ready build for this historical source version.

Response

published_build_idstring nullable required

Id of the canvas's live build (the last successful, still-eligible one). Null until a build completes.

current_version_idstring nullable required

Id of the source version the canvas's head points at.

Changes

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