Skip to content

clarification about heatmap click billing vs autocapture #1854

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

clarification about heatmap click billing vs autocapture #1854

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
10 changes: 9 additions & 1 deletion pages/docs/session-replay/heatmaps.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,9 @@ Heatmaps only capture data during sessions with recorded replays. If a page has

### Implementation

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`.
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`.

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.

**Example Usage**

Expand All @@ -36,6 +38,8 @@ mixpanel.init('YOUR_PROJECT_TOKEN', {

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.

Clicks captured by Autocapture are billable events that are counted against your plan data allowance.

**Example Usage**

```javascript Javascript
Expand All @@ -52,6 +56,10 @@ 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>

### Using Heatmaps

1. From the Home page, find the Heatmaps section
Expand Down
8 changes: 8 additions & 0 deletions pages/docs/session-replay/implement-session-replay/session-replay-web.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,8 @@ Enable Heatmap data collection by setting `record_heatmap_data` to `true` during

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.

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.

**Example Usage**

```javascript Javascript
Expand All @@ -180,6 +182,8 @@ mixpanel.init('YOUR_PROJECT_TOKEN', {

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.

Clicks captured by Autocapture are billable events that are counted against your plan data allowance.

**Example Usage**

```javascript Javascript
Expand All @@ -196,6 +200,10 @@ 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>

## Debugging

<Callout type="info">
Expand Down