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
  • group:preferences
  • group:rum-settings
  • group:privacy-settings
APPLICATION - Web application
environment
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:sessionreplay.web.privacy-preferences
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:sessionreplay.web.privacy-preferences
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:sessionreplay.web.privacy-preferences

Authentication

To execute this request, you need an access token with Read settings (settings.read) scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

Property
Type
Description
Required
Enable opt-in mode for Session Replay
enableOptInMode
boolean

When Session Replay opt-in mode is turned on, Session Replay is deactivated until explicitly activated via an API call.

required
URL exclusion
urlExclusionPatternList
set

Exclude webpages or views from Session Replay recording by adding URL exclusion rules

required
Content masking preferences
maskingPresets

To protect your end users' privacy, select or customize predefined masking options that suit your content recording and playback requirements.

required
The MaskingPresetConfig object
Property
Type
Description
Required
Recording masking settings
recordingMaskingPreset
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.

  • MASK_ALL
  • MASK_USER_INPUT
  • ALLOW_LIST
  • BLOCK_LIST
required
Allow list rules
recordingMaskingAllowListRules

The elements are defined by the CSS selector or attribute name.

required
Block list rules
recordingMaskingBlockListRules

The elements are defined by the CSS selector or attribute name.

required
Playback masking settings
playbackMaskingPreset
enum

Playback masking settings are applied during playback of recorded sessions, including playback of sessions that were recorded before these settings were applied.

  • MASK_ALL
  • MASK_USER_INPUT
  • ALLOW_LIST
  • BLOCK_LIST
required
Allow list rules
playbackMaskingAllowListRules

The elements are defined by the CSS selector or attribute name.

required
Block list rules
playbackMaskingBlockListRules

The elements are defined by the CSS selector or attribute name.

required
The AllowListRule object
Property
Type
Description
Required
Target
target
enum

Choose the masking rule target type

  • ELEMENT
  • ATTRIBUTE
required
CSS selector to identify the content element
cssExpression
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
Attribute name (expression)
attributeExpression
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
Type
Description
Required
Target
target
enum

Choose the masking rule target type

  • ELEMENT
  • ATTRIBUTE
required
CSS selector to identify the content element
cssExpression
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
Attribute name (expression)
attributeExpression
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
Hide user interaction
hideUserInteraction
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