Settings API - Session replay data privacy schema table
Session replay data privacy (builtin:sessionreplay.web.privacy-preferences)
Configure Session Replay to restrict data capture and protect your end users' data privacy.
| Schema ID | Schema groups | Scope |
|---|---|---|
builtin:sessionreplay.web.privacy-preferences |
| APPLICATION - Web applicationenvironment |
Parameters
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| enableOptInMode | Enable opt-in mode for Session Replay | boolean | When Session Replay opt-in mode is turned on, Session Replay is deactivated until explicitly activated via an API call. | required |
| urlExclusionPatternList | URL exclusion | set | Exclude webpages or views from Session Replay recording by adding URL exclusion rules | required |
| maskingPresets | Content masking preferences | MaskingPresetConfig | To protect your end users' privacy, select or customize predefined masking options that suit your content recording and playback requirements. | required |
Request body objects
The AllowListRule object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| target | Target | enum | Choose the masking rule target type | required |
| cssExpression | CSS selector to identify the content element | text | Content masking can be applied to webpages where personal data is displayed. When content masking is applied to parent elements, all child elements are masked by default. | required |
| attributeExpression | Attribute name (expression) | text | Attribute masking can be applied to web applications that store data within attributes, typically data-NAME attributes in HTML5. When you define attributes, their values are masked while recording but not removed. | required |
The BlockListRule object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| target | Target | enum | Choose the masking rule target type | required |
| cssExpression | CSS selector to identify the content element | text | Content masking can be applied to webpages where personal data is displayed. When content masking is applied to parent elements, all child elements are masked by default. | required |
| attributeExpression | Attribute name (expression) | text | Attribute masking can be applied to web applications that store data within attributes, typically data-NAME attributes in HTML5. When you define attributes, their values are masked while recording but not removed. | required |
| hideUserInteraction | Hide user interaction | boolean | Hide user interactions with these elements, including clicks that expand elements, highlighting that results from hovering a cursor over an option, and selection of specific form options. | required |
The MaskingPresetConfig object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| recordingMaskingPreset | Recording masking settings | enum | Recording masking settings are applied at record time. When you set these settings to a more restrictive option, the same option is also enabled for the playback masking settings. | required |
| recordingMaskingAllowListRules | Allow list rules | set | The elements are defined by the CSS selector or attribute name. | required |
| recordingMaskingBlockListRules | Block list rules | set | The elements are defined by the CSS selector or attribute name. | required |
| playbackMaskingPreset | Playback masking settings | enum | Playback masking settings are applied during playback of recorded sessions, including playback of sessions that were recorded before these settings were applied. | required |
| playbackMaskingAllowListRules | Allow list rules | set | The elements are defined by the CSS selector or attribute name. | required |
| playbackMaskingBlockListRules | Block list rules | set | The elements are defined by the CSS selector or attribute name. | required |