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 | ManagedDynatrace for Government | 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}:9999/e/{your-environment-id}/api/config/v1/applications/web/default/dataPrivacy |
Authentication
To execute this request, you need an access token with ReadConfig scope.
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 | Type | Description |
|---|---|---|
| 200 | ApplicationDataPrivacy | Success |
Response body objects
The ApplicationDataPrivacy object
Data privacy settings of the application.
| Element | Type | Description |
|---|---|---|
| dataCaptureOptInEnabled | boolean | Set to |
| doNotTrackBehaviour | string | How to handle the "Do Not Track" header:
|
| identifier | string | Dynatrace entity ID of the web application. |
| metadata | ConfigurationMetadata | Metadata useful for debugging |
| persistentCookieForUserTracking | boolean | Set to |
| sessionReplayDataPrivacy | SessionReplayDataPrivacySettings | Data privacy settings for Session Replay. |
The ConfigurationMetadata object
Metadata useful for debugging
| Element | Type | Description |
|---|---|---|
| clusterVersion | string | Dynatrace version. |
| configurationVersions | integer[] | A sorted list of the version numbers of the configuration. |
| currentConfigurationVersions | string[] | A sorted list of version numbers of the configuration. |
The SessionReplayDataPrivacySettings object
Data privacy settings for Session Replay.
| Element | Type | Description |
|---|---|---|
| contentMaskingSettings | SessionReplayContentMaskingSettings | Content masking settings for Session Replay. For more details, see Configure Session Replay in Dynatrace Documentation. |
| optInModeEnabled | boolean | If |
| urlExclusionRules | string[] | A list of URLs to be excluded from recording. |
The SessionReplayContentMaskingSettings object
Content masking settings for Session Replay.
For more details, see Configure Session Replay in Dynatrace Documentation.
| Element | Type | Description |
|---|---|---|
| playbackMaskingSettings | SessionReplayMaskingSetting | Configuration of the Session Replay masking. |
| recordingMaskingSettings | SessionReplayMaskingSetting | Configuration of the Session Replay masking. |
| 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 |
The SessionReplayMaskingSetting object
Configuration of the Session Replay masking.
| Element | Type | Description |
|---|---|---|
| maskingPreset | string | The type of the masking:
|
| 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 ( |
Response body JSON model
1{2 "dataCaptureOptInEnabled": true,3 "doNotTrackBehaviour": "CAPTURE_ANONYMIZED",4 "identifier": "string",5 "metadata": {6 "clusterVersion": "1.192.1",7 "configurationVersions": [8 4,9 210 ],11 "currentConfigurationVersions": [12 "1.0.4",13 "1.23"14 ]15 },16 "persistentCookieForUserTracking": true,17 "sessionReplayDataPrivacy": {18 "contentMaskingSettings": {19 "playbackMaskingSettings": {20 "maskingPreset": "ALLOW_LIST",21 "maskingRules": [22 {23 "maskingRuleType": "ATTRIBUTE",24 "selector": "string",25 "userInteractionHidden": false26 }27 ]28 },29 "recordingMaskingSettings": {},30 "recordingMaskingSettingsVersion": 231 },32 "optInModeEnabled": true,33 "urlExclusionRules": [34 "string"35 ]36 }37}