Skip to content

Commit 3675a48

Browse files
myronkaifungMyron Fung
andauthored
Myronkaifung sessionreplay reorg (#1830)
* new pages and index * top-level SR page (how to use) * add FAQ to top-level page * SR developer guide Web * SR developer guide iOS * SR developer guide android * SR declutter JS SDK page * add getReplayId methods for mobile * add meta for nested SDK pages * SR iOS SDK reference * add SR android SDK * update URLs and privacy tabbing * heatmaps * update privacy page name * heatmap images * fix conflict * heatmaps in JS SDK page * remove tabs from privacy page * reference to SR in SDK page * redirects * edit Android banner * small typo --------- Co-authored-by: Myron Fung <myronfung@MyronFung---MP-MBP.local>
1 parent 8a5dcf5 commit 3675a48

25 files changed

+1810
-1017
lines changed

pages/docs/session-replay.mdx

Lines changed: 61 additions & 77 deletions
Large diffs are not rendered by default.

pages/docs/session-replay/_meta.ts

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
export default {
2-
"session-replay-web": "Web",
3-
"session-replay-ios": "iOS (Beta)",
4-
"session-replay-android": "Android (Alpha)",
5-
"session-replay-privacy-controls": "Privacy Controls"
2+
"implement-session-replay": "Implement Session Replay",
3+
"session-replay-privacy-controls": "Session Replay Privacy Controls",
4+
"heatmaps": "Heatmaps (beta)"
65
}
Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
import { Callout } from 'nextra/components'
2+
3+
# Heatmaps (Beta)
4+
5+
<Callout type="info">
6+
Heatmaps are currently in private, closed beta. For early access, please contact your Account Manager.
7+
</Callout>
8+
9+
## Overview
10+
11+
Heatmaps help you visualize user interactions on your web application, showing where users click the most. This feature enables teams to quickly identify areas of high engagement and friction, helping to optimize user experiences and improve conversion rates.
12+
13+
Our initial version of Heatmaps is a click map, which means it specifically tracks clicks on individual site elements rather than just overlaying general activity on a page. This provides more precise insights into which modals, dropdowns, or features that users engage with the most. Future versions may also include hovers, scroll depth, and other interaction types.
14+
15+
Enabling Heatmaps does not affect billing. They are included with the Session Replay add-on and do not generate additional billable events.
16+
17+
### How It Works
18+
Heatmaps are powered by Session Replay data and automatically capture click interactions when enabled. Users can generate a Heatmap for specific pages to gain deeper insights into user engagement.
19+
20+
To function, Heatmaps require Session Replay to be enabled, as they rely on session replay data to track and visualize user clicks.
21+
22+
Heatmaps only capture data during sessions with recorded replays. If a page has limited replay coverage, the Heatmap may not offer meaningful insights.
23+
24+
### Implementation
25+
26+
Ensure you have Session Replay set up(see [developer guide on implementing Session Replay](/docs/session-replay/implement-session-replay/session-replay-web)), with the `record_heatmap_data` set to `true`.
27+
28+
**Example Usage**
29+
30+
```javascript Javascript
31+
mixpanel.init('YOUR_PROJECT_TOKEN', {
32+
record_sessions_percent: 1, // Session Replay enabled, recording 1% of all sessions
33+
record_heatmap_data: true // Enable Heatmap data collection
34+
});
35+
```
36+
37+
If you currently use [Autocapture](/docs/tracking-methods/autocapture) to track clicks, you can leverage these clicks to populate the Heatmaps without the `record_heatmap_data` init option.
38+
39+
**Example Usage**
40+
41+
```javascript Javascript
42+
mixpanel.init('YOUR_PROJECT_TOKEN', {
43+
autocapture: {
44+
pageview: "full-url",
45+
click: true, // click tracking enabled
46+
input: true,
47+
scroll: true,
48+
submit: true,
49+
capture_text_content: false,
50+
},
51+
record_sessions_percent: 1 // Session Replay enabled, recording 1% of all sessions
52+
});
53+
```
54+
55+
### Using Heatmaps
56+
57+
1. From the Home page, find the Heatmaps section
58+
59+
![heatmap_home.png](/heatmap_home.png)
60+
61+
2. Choose a URL where you want to analyze user interactions and generate a Heatmap.
62+
63+
![heatmap_sample.png](/heatmap_sample.png)
64+
65+
3. To easily navigate back to a created Heatmap, you can click the title to rename the Heatmap.
66+
67+
![heatmap_rename.png](/heatmap_rename.png)
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
import { Cards } from 'nextra/components'
2+
3+
# Implement Session Replay
4+
5+
Session Replay is supported on three platforms: Web, iOS, and Android. Additionally, can use Session Replay with CDPs (e.g., Segment and mParticle) through the Web platform.
6+
7+
See our developer guides on implementing Session Replay below to start recording replays.
8+
9+
## Web
10+
11+
<Cards>
12+
<Cards.Card icon title="Web" href="/docs/session-replay/implement-session-replay/session-replay-web" />
13+
</Cards>
14+
15+
## Mobile
16+
17+
<Cards>
18+
<Cards.Card icon title="iOS (Beta)" href="/docs/session-replay/implement-session-replay/session-replay-ios" />
19+
<Cards.Card icon title="Android (Alpha)" href="/docs/session-replay/implement-session-replay/session-replay-android" />
20+
</Cards>
21+
22+
Learn more about [viewing captured Replays in your project here](/docs/session-replay).
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
export default {
2+
"session-replay-web": "Web",
3+
"session-replay-ios": "iOS (beta)",
4+
"session-replay-android": "Android (alpha)"
5+
}

0 commit comments

Comments
 (0)