Document Scrollmaps on the Heatmaps page - #136
Draft
claude[bot] wants to merge 3 commits into
Draft
Conversation
Add a Scrollmaps section covering the live web-only feature: its requirements (JS SDK v2.71+, Session Replay enabled, and either record_heatmap_data or page_leave autocapture) and the Average Fold Line derived from the [Auto] Page Leave - Fold Line Percentage property. Also remove scroll depth from the list of future interaction types since it now ships for web.
Contributor
Confidence Score: 5/5The PR appears safe to merge. No blocking failure remains.
|
| Filename | Overview |
|---|---|
| docs/session-replay/heatmaps.mdx | Adds Scrollmaps documentation and correctly resolves the prior unclear page-leave configuration by using the documented record_heatmap_data path. |
Reviews (3): Last reviewed commit: "Merge remote-tracking branch 'origin/mai..." | Re-trigger Greptile
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
…page_leave clause
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
carlosdanieltt
approved these changes
Jul 29, 2026
# Conflicts: # docs/session-replay/heatmaps.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Requested by Amy Madden · Slack thread
What changed
Before: The Heatmaps page (
docs/session-replay/heatmaps.mdx) documented only two map types — Click Maps and Traditional Heatmaps — and listed scroll depth as a possible future interaction type ("Future versions of heatmaps may also include hovers, scroll depth, and other interaction types.").After: The page documents Scrollmaps as a live, web-only feature that is part of the Heatmaps / Session Replay feature set. It covers:
record_heatmap_data: trueorpage_leaveautocapture enabled.[Auto] Page Leave - Fold Line Percentageproperty.Also removed "scroll depth" from the list of future interaction types, since it now ships for web.
How
Single file changed:
docs/session-replay/heatmaps.mdx.## Scrollmapssection (with### Requirementsand### Average Fold Linesubsections) at the end of the page, matching the existing MDX component style (<Note>for the web-only caveat, fencedjavascriptexample consistent with the existing Implementation examples).No new UI navigation steps or screenshots were invented — the section describes the feature and its requirements only.
Reviewers
Confirmed by the heatmaps team: John La and Carlos Trevino. I was unable to resolve their GitHub handles from git history or CODEOWNERS (the repo was migrated in a single squashed commit, so there is no blame trail, and the CODEOWNERS entries are team-level
@mixpanel/docs-reviewers/@mixpanel/tofu). Please add them as reviewers manually.Generated by Claude Code