tracking_heatmaps_pages

Tool

tracking_heatmaps_pages

List the pages of the current product that have heatmap data (clicks, scroll depth) from session recordings, most sessions first.

List the pages of the current product that have heatmap data (clicks, scroll depth) from session recordings, most sessions first. A page is host + normalized path (no query, no hash, ids replaced by *). Filter by period (required, at most 30 days), device, campaign, source, conversion and page text; cursor-paged. sessions counts the recordings with a click or a scroll sample on the page, selected like tracking_recordings_list with the same filters. Returns: { pages, nextCursor }. Fails when: the period is longer than 30 days; cursor is not one this tool issued; the call carries no product.

Behavior

HTTP: GET /tracking/heatmaps/pages

Arguments

Name	Type	Required	Description
q	string	—	Only pages whose key contains this text, case-insensitively, e.g. /pricing.
to	string	•	End of the period, ISO 8601: recordings that started at or before it.
from	string	•	Start of the period, ISO 8601 (e.g. 2026-10-01T00:00:00Z): recordings that started at or after it. At most 30 days before `to`.
limit	integer	—	Pages per page of results, 1 to 100 (default 50).
cursor	string	—	Continue a previous page: pass the nextCursor it returned.
device	string	—	Only recordings from this kind of device: desktop, tablet or mobile. Omit for all.
converted	boolean	—	true: only sessions with a conversion or a payment; false: only sessions without one. Omit for both.
utmSource	string	—	Only recordings whose entry page carried this utm_source, e.g. google.
utmCampaign	string	—	Only recordings whose entry page carried this utm_campaign, e.g. spring.

Response

Field	Type	Always	Description
pages	array	•	Most sessions first.
nextCursor	string	•	Pass back as cursor for the next page. Null on the last page.

Try it

List the pages of the current product that have heatmap data (clicks, scroll depth) from session recordings, most sessions first.

When to use

Example

Ask your agent something like this:

List the pages of the current product that have heatmap data (clicks, scroll depth) from session recordings, most sessions first.

The agent will invoke tracking_heatmaps_pages with these arguments:

{
  "to": "<to>",
  "from": "<from>"
}