Web application configuration API - GET data privacy of a web application

Gets data privacy parameters of the specified web application.

This API only supports web applications (including agentless applications and browser extensions). Mobile apps, AMP applications and custom applications are not supported.

The request produces an application/json payload.

GET
  • Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/applications/web/{id}/dataPrivacy
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/applications/web/{id}/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

Parameter Type Description In Required
id string

The ID of the web application where you want to check data privacy settings.

path required

Response format

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 browsers' "Do Not Track": IGNORE_DO_NOT_TRACK, or CAPTURE_ANONYMIZED, or DO_NOT_CAPTURE.

The doNotTrackBehaviour element can hold these values.

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 string version numbers of the configuration.

clusterVersion string

Dynatrace server version.

Possible values

Possible values for the doNotTrackBehaviour element in the ApplicationDataPrivacy object:

  • CAPTURE_ANONYMIZED
  • DO_NOT_CAPTURE
  • IGNORE_DO_NOT_TRACK