Web application configuration API - GET data privacy of the default application

Gets data privacy parameters of the default web application of your Dynatrace environment.

The request produces an application/json payload.

GET
  • Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/applications/web/default/dataPrivacy
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/applications/web/default/dataPrivacy
  • Environment ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/applications/web/default/dataPrivacy

Authentication

To execute this request, you need the Read configuration (ReadConfig) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.

Parameters

The request doesn't provide any configurable parameters.

Response

Response codes

Code Description
200

Success

Response body

The ApplicationDataPrivacy object

Data privacy settings of the application.

Element Type Description
metadata ConfigurationMetadata
identifier string

Dynatrace entity ID of the web application.

dataCaptureOptInEnabled boolean

Set to true to disable data capture and cookies until JavaScriptAPI dtrum.enable() is called.

persistentCookieForUserTracking boolean

Set to true to set persistent cookie in order to recognize returning devices.

doNotTrackBehaviour string

How to handle the "Do Not Track" header:

  • IGNORE_DO_NOT_TRACK: ignore the header and capture the data.
  • CAPTURE_ANONYMIZED: capture the data but do not tie it to the user.
  • DO_NOT_CAPTURE: respect the header and do not capture.
sessionReplayDataPrivacy SessionReplayDataPrivacySettings

The SessionReplayDataPrivacySettings object

Data privacy settings for Session Replay.

Element Type Description
optInModeEnabled boolean

If true, session recording is disabled until JavaScriptAPI dtrum.enableSessionReplay() is called.

urlExclusionRules string[]

A list of URLs to be excluded from recording.

contentMaskingSettings SessionReplayContentMaskingSettings

The SessionReplayContentMaskingSettings object

Content masking settings for Session Replay.

For more details, see Configure Session Replay in Dynatrace Documentation.

Element Type Description
recordingMaskingSettingsVersion integer

The version of the content masking.

You can use this API only with the version 2.

If you're using version 1, set this field to 2 in the PUT request to switch to version 2.

recordingMaskingSettings SessionReplayMaskingSetting
playbackMaskingSettings SessionReplayMaskingSetting

The SessionReplayMaskingSetting object

Configuration of the Session Replay masking.

Element Type Description
maskingPreset string

The type of the masking:

  • MASK_ALL: Mask all texts, user input, and images.
  • MASK_USER_INPUT: Mask all data that is provided through user input
  • ALLOW_LIST: Only elements, specified in maskingRules are shown, everything else is masked.
  • BLOCK_LIST: Elements, specified in maskingRules are masked, everything else is shown.
maskingRules MaskingRule[]

A list of masking rules.

The MaskingRule object

The masking rule defining how data is hidden.

Element Type Description
maskingRuleType string

The type of the masking rule.

selector string

The selector for the element or the attribute to be masked.

Specify a CSS expression for an element or a regular expression for an attribute.

userInteractionHidden boolean

Interactions with the element are (true) or are not (`false) masked.

The ConfigurationMetadata object

Metadata useful for debugging

Element Type Description
configurationVersions integer[]

A sorted list of the version numbers of the configuration.

currentConfigurationVersions string[]

A sorted list of version numbers of the configuration.

clusterVersion string

Dynatrace version.