provider saved PATCH /api/environments/{environment_id}/saved/{short_id}/
@utdk/posthog /api/environments/{environment_id}/saved/{short_id}/
environments_saved_partial_update
Update a saved heatmap (e.g. rename, change widths, or soft-delete via 'deleted'). Changing the URL of a 'screenshot' heatmap triggers a re-render.
environment_id path required
Deprecated. Use /api/projects/{project_id}/ instead.
string
short_id path required
string

Try it

Authentication
Configure credentials for PostHog API
environmentsSavedPartialUpdate
PATCH/api/environments/{environment_id}/saved/{short_id}/
Update a saved heatmap (e.g. rename, change widths, or soft-delete via 'deleted'). Changing the URL of a 'screenshot' heatmap triggers a re-render.

Parameters

required

Deprecated. Use /api/projects/{project_id}/ instead.

required

Input

Human-readable label for the saved heatmap.

Exact page URL to render and overlay heatmap data on. Wildcards are not allowed.

URL whose heatmap data is overlaid on the screenshot. Defaults to 'url' when omitted.

Viewport widths (px, 100-3000) to render the heatmap screenshot at — one render per width. Defaults to [320, 375, 425, 768, 1024, 1440, 1920] when omitted. At most 16 widths.

Render mode: 'screenshot' (renders the page headlessly, default), 'iframe', or 'recording'. Only 'screenshot' generates image bytes. * `screenshot` - Screenshot * `iframe` - Iframe * `recording` - Recording

Set true to soft-delete the saved heatmap.

When true, ask the headless browser to dismiss cookie/consent banners before capturing the screenshot. Off by default: the blocker can stall the render on some sites and time out. Only applies to 'screenshot' heatmaps.

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.environmentsSavedPartialUpdate({
  "type": "screenshot"
})