provider heatmap_screenshots GET /api/projects/{project_id}/heatmap_screenshots/{id}/content/
@utdk/posthog /api/projects/{project_id}/heatmap_screenshots/{id}/content/
heatmap_screenshots_content_retrieve
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.
id path required
A UUID string identifying this saved heatmap.
string
project_id path required
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
string
width query
Viewport width (CSS pixels) to fetch. Defaults to 1024. If no exact render exists for this width the closest available one is returned.
integer

Try it

Authentication
Configure credentials for PostHog API
heatmapScreenshotsContentRetrieve
GET/api/projects/{project_id}/heatmap_screenshots/{id}/content/
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.

Parameters

required

A UUID string identifying this saved heatmap.

required

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

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

Configure credentials above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import posthog from '@utdk/posthog';

await posthog.heatmapScreenshotsContentRetrieve()