What exactly is captured?
When click capture is enabled for a site, each click records exactly this — and nothing else:- two coordinate pairs (position in the viewport, position on the page),
- the viewport and page size at the time,
- whether the clicked element was pinned (a sticky header or floating button),
- the click type (
clickorrageclick), - the page’s path.
How do I turn it on?
Click capture is off by default. Enable it per site under Site Settings → Tracking → Heatmaps. Once enabled, the tracker lazy-loads a small (~1 KB) capture script on your pages; while it’s off, nothing loads and nothing is captured — sites that never opt in pay zero extra bytes. Turning the toggle off later stops accepting capture immediately, even for pages that are still open.Scroll maps don’t need the toggle at all: they’re computed from the engagement data your
tracker already collects, so they work retroactively — including for date ranges before you
ever opened the Heatmaps page.
/api/site/:siteId/tracking-config, /script-heatmap.js, and /api/heatmap
through the same proxy prefix as the core tracking script.
The three map modes
Open Engagement → Heatmaps, pick a page from the list (searchable, busiest first), and choose a mode:
The click modes also show a fold line — the median visitor’s viewport bottom — with the share
of clicks that happen below it, and a summary of total clicks and unique visitors. You can weight
the map by raw clicks or by unique visitors.
Device width bands
A click at x = 600 means something different on a phone than on a desktop monitor, so clicks are never mixed across device sizes. Each map renders one band — Mobile, Tablet, or Desktop — and only the clicks from viewports in that band, gently rescaled to the band’s render width:The page preview
The map is drawn over a live<iframe> of your page. If your site doesn’t allow embedding
(a frame-ancestors policy or X-Frame-Options header), the map switches to a neutral
wireframe background instead — the coordinates, hotspots, and fold line are unaffected. You
can also switch between Live page and Wireframe manually from the preview header.
Scroll depth is recorded once per page load and attributed to the path the visitor left from,
so scroll maps are approximate for single-page apps that navigate client-side.
Reading the data over the API
Three endpoints power the page and are available in the API playground:GET /api/sites/:id/heatmap/pageslists pages with click data.GET /api/sites/:id/heatmap/clicksreturns binned click or rage-click intensity for one page and device band.GET /api/sites/:id/heatmap/scrollreturns cumulative reach for each 10% scroll band.