Get Heatmap Scroll Reach
Cumulative scroll-depth reach for one page: % of sessions that reached each 10% band. Reads existing engagement data, so it works retroactively.
Authorizations
An API key created in your account settings, sent as Authorization: Bearer <key>.
Path Parameters
Site ID.
Query Parameters
Start of the range, as YYYY-MM-DD.
End of the range, as YYYY-MM-DD.
IANA time zone used to bucket the range, e.g. America/New_York.
"America/New_York"
JSON-encoded array of filter objects, each { dimension, op, value } where value is an array. Example: [{"dimension":"country","op":"equals","value":["US"]}]. A user-trait filter uses the templated dimension trait:<key> — [{"dimension":"trait:plan","op":"equals","value":["pro"]}] — and matches identified users only, by the trait's current value. Trait ops: equals, not_equals, contains, not_contains, starts_with, ends_with, is_null ("is not set"), is_not_null ("is set"); regex is not available. Trait filters require a member session or a users:read key, max 4 per query, and a filter matching more than 10,000 identified users fails with TRAIT_FILTER_TOO_BROAD.
Example: /pricing.
Response
Success.
Related topics
Website Heatmaps: Click, Rage-Click, and Scroll MapsTinyAnalytics Agent Skills for AI Coding AgentsSet up a first-party analytics proxy