heatmap_screenshots

Fetch the rendered screenshot image (JPEG bytes) for a saved heatmap at a given viewport width. Returns 202 with the saved-heatmap metadata while the screenshot is still being generated.

get/api/projects/{project_id}/heatmap_screenshots/{id}/content/

Request

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

Path parameters

idstring uuid required

A UUID string identifying this saved heatmap.

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

widthinteger

Viewport width (CSS pixels) to fetch. Defaults to 1024. If no exact render exists for this width the closest available one is returned.

Changes

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