Skip to content

Document Scrollmaps on the Heatmaps page - #136

Draft
claude[bot] wants to merge 3 commits into
mainfrom
docs-scrollmaps-heatmaps
Draft

Document Scrollmaps on the Heatmaps page#136
claude[bot] wants to merge 3 commits into
mainfrom
docs-scrollmaps-heatmaps

Conversation

@claude

@claude claude Bot commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

Requested by Amy Madden · Slack thread

Draft — pending product-accuracy review. The heatmaps team confirmed this feature and should review before merge (see Reviewers below).

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:

  • What Scrollmaps show (how far down a page users scroll).
  • Requirements: Mixpanel JavaScript SDK v2.71 or higher, Session Replay enabled, and either record_heatmap_data: true or page_leave autocapture enabled.
  • The Average Fold Line, derived from the [Auto] Page Leave - Fold Line Percentage property.
  • A "web only" caveat (not yet available on the Mobile Session Replay SDKs).

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.

  • Added a ## Scrollmaps section (with ### Requirements and ### Average Fold Line subsections) at the end of the page, matching the existing MDX component style (<Note> for the web-only caveat, fenced javascript example consistent with the existing Implementation examples).
  • Edited the stale "future" wording in the Overview.

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

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.
Comment thread docs/session-replay/heatmaps.mdx Outdated
@greptile-apps

greptile-apps Bot commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

Confidence Score: 5/5

The PR appears safe to merge.

No blocking failure remains.

Important Files Changed

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

@mintlify

mintlify Bot commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
mixpanel-docs 🟢 Ready View Preview Jul 29, 2026, 12:40 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@mintlify

mintlify Bot commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
mixpanel-docs 🟡 Building Jul 29, 2026, 12:37 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

# Conflicts:
#	docs/session-replay/heatmaps.mdx
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants