Skip to content

docs: frustration analytics docs #786

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

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
Draft

docs: frustration analytics docs #786

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f09d1d5
docs: frustration analytics docs
daniel-graham-amplitude Jun 20, 2025
aa42f51
add event information
daniel-graham-amplitude Jun 20, 2025
75a8d37
again
daniel-graham-amplitude Jun 20, 2025
2ec119d
again
daniel-graham-amplitude Jun 20, 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
61 changes: 61 additions & 0 deletions content/collections/browser_sdk/en/browser-sdk-2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,7 @@
- Form interactions
- File downloads
- Element interactions
- Frustration interactions
- Network tracking


Expand All @@ -228,6 +229,7 @@
| `config.autocapture.formInteractions` | Optional. `boolean` | Enables/disables form interaction tracking. If `true`, Amplitude tracks form start and form submit events. Event properties tracked includes: `[Amplitude] Form ID`, `[Amplitude] Form Name`, `[Amplitude] Form Destination`. Default value is `true`. See [Track form interactions](#track-form-interactions) for more information. |
| `config.autocapture.fileDownloads` | Optional. `boolean` | Enables/disables file download tracking. If `true`, Amplitude tracks file download events otherwise. Event properties tracked includes: `[Amplitude] File Extension`, `[Amplitude] File Name`, `[Amplitude] Link ID`, `[Amplitude] Link Text`, `[Amplitude] Link URL`. Default value is `true`. See [Track file downloads](#track-file-downloads) for more information. |
| `config.autocapture.elementInteractions` | Optional. `boolean` | Enables/disables element interaction tracking. If `true`, Amplitude tracks clicks and form field interactions. Default value is `false`. See [Track element interactions](#track-element-interactions) for more information and configuration options. |
| `config.autocapture.frustrationInteractions` | Optional. `boolean` | Enables/disables frustration interaction tracking. If `true`, Amplitude tracks dead clicks and rage clicks. Default value is `false`. See [Track frustration interactions](#track-frustration-interactions) for more information and configuration options. |
| `config.autocapture.networkTracking` | Optional. `boolean` | Enables/disables network tracking. If `true`, Amplitude tracks failed network requests. To configure what gets captured, set this as a network tracking options object. Default value is `false`. See [Track network interactions](#track-network-requests) for more information and configuration options. |

{{/partial:collapse}}
Expand All @@ -250,6 +252,7 @@
formInteractions: false,
fileDownloads: false,
elementInteractions: false,
frustrationInteractions: false,
},
});

Expand Down Expand Up @@ -646,6 +649,64 @@
<!-- vale on-->
{{/partial:collapse}}

### Track frustration interactions

You can enable frustration interaction tracking to capture dead clicks and rage clicks. Review our page on [Autocapture privacy and security](/docs/data/autocapture#privacy-and-security) for more information about the data collected with these events.

Set `config.autocapture.frustrationInteractions` to `true` to enable dead click and rage click tracking (default `false`)

```ts
amplitude.init(AMPLITUDE_API_KEY, {
autocapture: {
frustrationInteractions: true, //[tl! highlight]
},
});
```

#### Advanced configuration for frustration interactions

Use the advanced configuration to control frustration interaction tracking.

{{partial:collapse name="Tracking frustration interaction options"}}

| Name | Value | Description |
| ------------------------------------------------------------- | ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `config.autocapture.frustrationInteractions.deadClicks` | Optional. `boolean or object` | Enable dead click tracking (default `true`) |
| `config.autocapture.frustrationInteractions.deadClicks.cssSelectorAllowlist` | Optional. `(string)[]` | Accepts one or more CSS selectors that define which elements should have dead clicks tracked. By default, this is set to `[TODO: FILL ME IN WHEN READY]` |
| `config.autocapture.frustrationInteractions.rageClicks` | Optional. `boolean or object` | Enable rage click tracking (default `true`) |
| `config.autocapture.frustrationInteractions.rageClicks.cssSelectorAllowlist` | Optional. `(string)[]` | Accepts one or more CSS selectors that define which elements should have rage clicks tracked on. By default, this is set to `[TODO: FILL ME IN WHEN READY]` |
| `config.autocapture.frustrationInteractions.pageUrlAllowlist` | Optional. `(string\|RegExp)[]` | Defines the URL, URLs, or URL pattern on which Amplitude tracks element click and change events. By default, frustration interactions will be captured on any URL if undefined. |

Check warning on line 678 in content/collections/browser_sdk/en/browser-sdk-2.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Amplitude.Passive] 'be captured' looks like passive voice.

Raw Output:
{"message": "[Amplitude.Passive] 'be captured' looks like passive voice.", "location": {"path": "content/collections/browser_sdk/en/browser-sdk-2.md", "range": {"start": {"line": 678, "column": 243}}}, "severity": "WARNING"}

Check warning on line 678 in content/collections/browser_sdk/en/browser-sdk-2.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Amplitude.Will] Future tense! Avoid using 'will be'.

Raw Output:
{"message": "[Amplitude.Will] Future tense! Avoid using 'will be'.", "location": {"path": "content/collections/browser_sdk/en/browser-sdk-2.md", "range": {"start": {"line": 678, "column": 238}}}, "severity": "WARNING"}
| `config.autocapture.frustrationInteractions.dataAttributePrefix` | Optional. `(string\|RegExp)[]` | Allows the SDK to capture data attributes as an event property. By default, this is set to `data-amp-track`. |

{{/partial:collapse}}


{{partial:collapse name="Frustration interaction events"}}
When you enable frustration interactions for Autocapture, Amplitude sends two events

- `[Amplitude] Dead Click`
- `[Amplitude] Rage Click`

Dead click events capture the same properties as `[Amplitude] Element Clicked` plus:

<!-- vale off-->
- `[Amplitude] X`
- `[Amplitude] Y`
<!-- vale on-->

Rage click events capture the same properties as `[Amplitude] Element Clicked` plus:

<!-- vale off-->
- `'[Amplitude] Begin Time'`
- `'[Amplitude] End Time'`
- `'[Amplitude] Duration'`
- `'[Amplitude] Clicks'`
- `'[Amplitude] Click Count'`
<!-- vale on-->

{{/partial:collapse}}


### Track network requests

Track when network requests fail (supports XHR and fetch). By default, tracks network requests with a response code in the range `500-599`, excluding requests made to any `amplitude.com` domain.
Expand Down
Loading