Clicks and scroll depth
get_heatmapWhere visitors click and how far they scroll. Without page_path, ranks pages by clicks with rage and dead clicks and scroll depth; with page_path, the most clicked elements on that page (CSS selectors) and how many visits reached 25, 50, 75 and 100% of it. Needs the heatmaps tracker feature (get_site shows it).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| to | No | Last day, inclusive, YYYY-MM-DD; default today | |
| from | No | First day, YYYY-MM-DD; overrides period | |
| limit | No | Rows to return, at most 50 | |
| device | No | desktop | |
| period | No | Window ending now; days are whole days in the timezone. Ignored when from is set. | 30d |
| site_id | Yes | site_id from list_sites; a site name, slug or domain also resolves | |
| hostname | No | With page_path, when the site serves several hostnames | |
| timezone | No | IANA zone for day boundaries; default the user's | |
| page_path | No | e.g. /pricing |