Web application configuration API - GET data privacy of all web applications

Gets data privacy parameters of all web applications configured in your DESK environment.

This API only supports rule-based web applications. Mobile apps, agentless applications, browser extensions, etc. are not supported.

The request produces an application/json payload.

GET	Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/applications/web/dataPrivacy SaaS https://{your-environment-id}.live.dexp.ae/api/config/v1/applications/web/dataPrivacy

Authentication

To execute this request, you need the Read configuration permission assigned to your API token. See the Authentication page to learn how to obtain and use it.

Parameters

The request doesn't provide any configurable parameters.

Response format

Response parameters JSON model

The ApplicationDataPrivacyList object

Element	Type	Description
metadata	ConfigurationMetadata	Metadata useful for debugging.
values	ApplicationDataPrivacy[]

The ApplicationDataPrivacy object

Data privacy settings of the application.

Element	Type	Description
metadata	ConfigurationMetadata	Metadata useful for debugging.
identifier	string	DESK 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 ConfigurationMetadata object

Metadata useful for debugging

Element	Type	Description
configurationVersions	integer[]	A Sorted list of the version numbers of the configuration.
clusterVersion	string	DESK server version.

    
{
  "metadata": {
    "configurationVersions": [
      "integer"
    ],
    "clusterVersion": "string"
  },
  "values": [
    {
      "metadata": {
        "configurationVersions": [
          "integer"
        ],
        "clusterVersion": "string"
      },
      "identifier": "string",
      "dataCaptureOptInEnabled": true,
      "persistentCookieForUserTracking": true,
      "doNotTrackBehaviour": "CAPTURE_ANONYMIZED"
    }
  ]
}