get_click_heatmap
A 10-by-10 grid of a page showing which zones receive clicks, with rage and dead breakdowns per zone, plus an ASCII rendering.
When to use it
When you want to know where on the page attention lands, rather than which selector received it.
Ask for it like this
You do not name the tool. These are questions that make an assistant reach for it:
Show me a heatmap of my homepage on mobile.
Where do people click on my cart page?
How to read the result
- Always pass device. Mobile and desktop are different layouts, and the default cross-device rollup blends them into a grid that describes neither.
- Zone (0,0) is top-left, (9,9) is bottom-right.
- For zones with elevated dead or rage clicks, call get_page_dom_snapshot to see what sits at that position, then get_element_click_analysis for the exact selector.
Parameters
url
Page to analyse, matched as a substring.
Shared parameters it accepts
Documented in full on the tool reference index.
Date window — defaults to the last 30 days.
dateFrom
Start of the window, YYYY-MM-DD. Inclusive.
dateTo
End of the window, YYYY-MM-DD. Inclusive.
Device — this tool takes device only, not the full session filter set.
device
Keep only sessions on this device class.
mobiletabletdesktopEvery tool also accepts merchantId, which resolves from your connection. You never pass it.
What comes back
JSON. These are the top-level keys; date-scoped tools additionally carry a _meta block with the server date and the data coverage envelope.
asciiGrid
A text rendering of the grid, readable without a plotting library.
zones
Per zone: coordinates, clicks, rage clicks and dead clicks.
description
How to interpret the coordinate system.