Heatmaps

Heatmaps are off by default. Turn them on per site under Settings → Collection → Heatmaps; clicks are collected from then on. Turning them off stops collection and keeps what was collected.

Opening the overlay

In the dashboard’s Heatmaps tab, pick a page and choose Open on site. Your page opens with a #pt-heatmap=… token; the tracker then measures nothing, removes the token from the address and loads the overlay (about 4 KB gzip), which draws the clicks on the page. The token lasts 15 minutes and works only for members of the site’s workspace.

Your page must run tracker 0.2.1 or later, and the overlay only opens for the dashboard your collector is configured for.

What is recorded

For each click: a stable selector for the element, the position inside it (0–1000 on each axis), the screen size class (desktop, tablet, mobile), and whether it was a rage click (three or more in one spot within 700 ms) or a dead click (nothing changed for a second: no navigation, no new content, no focus, no text selected).

Never the text clicked on (buttons and links are told apart by a short hash of their text), never a field’s value. Password and card fields, and anything inside an element with data-pt-ignore, are never recorded. At most 50 clicks per page view, with no visit or visitor id.

Could not be placed

Clicks are stored against the element, so they survive layout changes. When an element no longer exists on the current page, its clicks are counted as could not be placed and that share is shown. They are never drawn at a guessed position.

API: GET /v1/sites/{id}/heatmaps/pages and GET /v1/sites/{id}/heatmaps?path=/pricing.