• Home
  • Dynatrace API
  • Environment
  • Settings
  • Schemas
  • Session replay data privacy

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 IDSchema groupsScope
builtin:sessionreplay.web.privacy-preferences
  • group:preferences
  • group:privacy-settings
APPLICATION - Web application
environment
Retrieve schema via Settings API
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

PropertyLabelTypeDescriptionRequired
enableOptInModeEnable opt-in mode for Session Replayboolean

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

required
urlExclusionPatternListURL exclusionset

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

required
maskingPresetsContent masking preferencesMaskingPresetConfig

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
PropertyLabelTypeDescriptionRequired
targetTargetenum

Choose the masking rule target type

required
cssExpressionCSS selector to identify the content elementtext

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
attributeExpressionAttribute 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
PropertyLabelTypeDescriptionRequired
targetTargetenum

Choose the masking rule target type

required
cssExpressionCSS selector to identify the content elementtext

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
attributeExpressionAttribute 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
hideUserInteractionHide user interactionboolean

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
PropertyLabelTypeDescriptionRequired
recordingMaskingPresetRecording masking settingsenum

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
recordingMaskingAllowListRulesAllow list rulesset

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

required
recordingMaskingBlockListRulesBlock list rulesset

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

required
playbackMaskingPresetPlayback masking settingsenum

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

required
playbackMaskingAllowListRulesAllow list rulesset

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

required
playbackMaskingBlockListRulesBlock list rulesset

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

required