saved

Persist screenshots captured client-side by the on-page toolbar as a completed screenshot heatmap. No headless render is enqueued: the toolbar runs in the user's authenticated browser, so this is the path for pages behind a login that Browserless cannot reach. Send one 'image'+'width', or 'images'+'widths' parallel arrays to store several viewport widths on one heatmap (the toolbar re-lays out the page at each width and captures it, matching the widths the server renders). The image bytes are stored and served only through the authenticated content endpoint. The optional data URL selects which pages supply the overlay data and defaults to the captured URL.

post/api/projects/{project_id}/saved/capture/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/saved/capture/
  • Auth: HTTP bearer

Path parameters

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

idstring uuid required
short_idstring required

Short, URL-safe identifier used as the lookup key for saved-heatmap routes.

namestring nullable

Human-readable label for the saved heatmap.

urlstring uri required

The page URL this saved heatmap renders and overlays data on.

data_urlstring

URL whose heatmap data is overlaid on the screenshot (defaults to 'url').

target_widthsinteger[] required

Viewport widths (CSS pixels) the screenshot is rendered at.

type'screenshot' | 'iframe' | 'recording'
  • screenshot - Screenshot
  • iframe - Iframe
  • recording - Recording
source'server' | 'toolbar' required
  • server - Server
  • toolbar - Toolbar
status'processing' | 'completed' | 'failed' required
  • processing - Processing
  • completed - Completed
  • failed - Failed
has_contentboolean required

Whether at least one rendered image is ready to fetch.

deletedboolean

Soft-delete flag; deleted heatmaps are hidden from the list.

block_consent_modalsboolean

Whether the headless browser dismisses cookie/consent banners before capturing the screenshot. Only applies to 'screenshot' heatmaps.

created_atstring date-time required
updated_atstring date-time required
exceptionstring nullable required

Error detail when screenshot generation failed, otherwise null.

user_access_levelstring nullable required

The effective access level the user has for this object

Changes

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