Skip to content

Dj rage clicks heatmap data docs #2195

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 28, 2025
Merged

Dj rage clicks heatmap data docs #2195

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c61e4e1
Rage clicks and dead clicks, making it clearer
djmixpanel Oct 27, 2025
aab4f23
One more tiny change
djmixpanel Oct 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 15 additions & 11 deletions pages/docs/tracking-methods/sdks/javascript/javascript-replay.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,28 +172,34 @@ mixpanel.get_session_replay_url();
// https://mixpanel.com/projects/replay-redirect?replay_id=19307d78e24394fe15-0cd98d8fd9ad1d-1f525636-4b9600-19307d78e28194fe15&distinct_id=123&token=my-project-token
```

## Heatmaps
## Heatmaps, Rage Clicks, and Dead Clicks (Web Only)

To supplement your Session Replay data, enable [Heatmaps](/docs/session-replay/heatmaps) data collection. The current Heatmap functions as a click map, tracking user interactions with individual site elements.
The `record_heatmap_data` option (Web only; not available on mobile) enables three types of interaction tracking during replay sessions:

Enable Heatmap data collection by setting `record_heatmap_data` to `true` during library initialization.
1. **Click events** - Captures user clicks to populate click heatmaps
2. **Rage clicks** - Captures multiple rapid clicks on the same element (`$mp_rage_click`)
3. **Dead clicks** - Captures clicks on unresponsive elements (`$mp_dead_click`)

Ensure Session Replay is enabled, as Heatmaps only collect data during sessions with recorded replays. If a page has limited replay coverage, the resulting Heatmap may provide limited or less meaningful insights.
These events are only captured when a session recording is in progress, and they are exempt from your plan data allowance.

Clicks recorded using `record_heatmap_data` will only capture clicks while an a session recording is in progress. These clicks are sent as `$mp_click` and will not be counted against your plan data allowance.
**Important:** Session Replay must be enabled for `record_heatmap_data` to work. Heatmaps only collect data during sessions with recorded replays. If a page has limited replay coverage, the resulting Heatmap may provide limited or less meaningful insights.

**Example Usage**

```javascript Javascript
mixpanel.init('YOUR_PROJECT_TOKEN', {
record_sessions_percent: 1, // Session Replay must be enabled for Heatmap
record_heatmap_data: true // Enable Heatmap data collection
record_heatmap_data: true // Enable Heatmap, Rage Click, and Dead Click collection
});
```

If you use [Autocapture](/docs/tracking-methods/autocapture) to track clicks, you can leverage these clicks to populate the Heatmaps without setting the `record_heatmap_data` option during library initialization.
<Callout type="info">
Events generated by `record_heatmap_data` (clicks, rage clicks, dead clicks) are exempt from your plan data allowance.
</Callout>

Clicks captured by Autocapture are billable events that are counted against your plan data allowance.
### Alternative: Using Autocapture for Heatmaps

If you use [Autocapture](/docs/tracking-methods/autocapture) to track clicks, you can leverage these clicks to populate Heatmaps without enabling `record_heatmap_data`. Autocapture also supports rage and dead click detection.

**Example Usage**

Expand All @@ -211,9 +217,7 @@ mixpanel.init('YOUR_PROJECT_TOKEN', {
});
```

<Callout type="info">
Clicks generated by `record_heatmap_data` are exempt from your plan data allowance. Clicks generated by [Autocapture](/docs/tracking-methods/autocapture) are billable events.
</Callout>
Clicks captured by Autocapture are billable events that are counted against your plan data allowance.

## Debugging

Expand Down