Skip to content

[Session Replay] Updates to heat maps beta docs #1846

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
djmixpanel merged 1 commit into from
Apr 21, 2025
Merged

[Session Replay] Updates to heat maps beta docs #1846

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion pages/docs/session-replay.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ Heatmaps are powered by session replay data and automatically capture click inte
### Implementation
Ensure you have Session Replay set up, and [click interaction tracking enabled](/docs/tracking-methods/sdks/javascript#heatmaps-beta). Session Replays are required for Heatmaps to work.

Note: if you already utilize Mixpanel's [autocapture functionality](/docs/tracking-methods/autocapture) to capture clicks, then these clicks can be used to populate Heatmaps
Note: If you already utilize Mixpanel's [autocapture functionality](/docs/tracking-methods/autocapture) to capture clicks, then these clicks can be used to populate Heatmaps.

### Using Heatmaps
1. From the Home page, find the Heatmaps section
Expand Down
8 changes: 5 additions & 3 deletions pages/docs/tracking-methods/sdks/javascript.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -947,13 +947,15 @@ Note: This is the only change needed in your existing JavaScript SDK setup to en
| `record_min_ms` | Minimum length of a single replay in milliseconds. Up to 8 seconds is supported. If a replay does not meet the minimum length, it will be discarded. | `0`<br/>(0 seconds) |
| `record_sessions_percent` | Percentage of SDK initializations that will qualify for replay data capture. A value of "1" = 1%. | `0` |
| `record_canvas` | When true, Mixpanel will record snapshots of `<canvas>` elements on your site at up to 15 frames per second | `false` |
| `record_heatmap_data` | When true, Mixpanel will capture click events during replays to populate heatmaps. Viewing heatmaps is currently in Beta. | `false` |
| `record_heatmap_data` | When true, Mixpanel will capture click events during replays to populate Heatmaps. Viewing Heatmaps is currently in Beta. | `false` |

### Heatmaps (Beta)

In order to collect data to populate heatmaps, use the `record_heatmap_data` init option.
In order to collect data to populate Heatmaps, use the `record_heatmap_data` init option.

Note that heatmaps are currently in private, closed beta. For early access, please contact your Account Manager.
Note: If you already utilize Mixpanel's [autocapture functionality](/docs/tracking-methods/autocapture) to capture clicks, then these clicks can be used to populate Heatmaps.

Note: Heatmaps are currently in private, closed beta. For early access, please contact your Account Manager.

### Session Replay Methods

Expand Down