For the complete documentation index, see llms.txt. This page is also available as Markdown.

Download privacy record

Didomi enables your organization to download a comprehensive privacy record or specific event within a privacy record onto your local machine as a CSV or PDF file.

Download privacy record overview

In this section, we will cover different ways your organization can download a privacy record onto your local machine (either as a CSV or PDF file).

  • Download full privacy record

  • Download privacy record event

To start, click Versions & Proofs on the left-hand panel and select the Privacy Records tab on the subsequent page.

Download full privacy record

Navigate to an existing privacy record and click the Download icon inline with privacy record.

Select your desired format from the drop-down menu.

The full privacy record will be downloaded onto your local machine in your specified format.

Alternatively, a full privacy record can be downloaded by clicking the Preview icon and then selecting the Download icon in the header of the preview page.

Download privacy record event

Navigate to a privacy record and click the Preview icon inline with the privacy record.

Navigate to an event on the subsequent page for the privacy record and click the Download icon inline with the event.

Select your desired format from the drop-down menu.

The privacy record event will be downloaded onto your local machine in your specified format.

Alternatively, a privacy record event can be downloaded by clicking the Preview icon inline with the event and then selecting the Download icon in the header of the preview page.

Reference: CSV glossaries

Expand the accordion below for definitions of terms found in the downloaded CSV version of a privacy record.

Preference Management Platform (PMP) CSV glossary
Field
Data Type
Description

id

String

ID for the event

type

String

Type of event (e.g. consent.given)

source

Object

Details of the source on which the event occurred

source.domain

String

Domain name of the source on which the event occurred (e.g. www.example.com)

source.type

String

Source type on which the event occurred (e.g. website)

source.deployment_id

String

Unique ID assigned to this version of the widget when it was published

user

Object

End-user details

user.country

String

Two-letter country code (ISO 3166-1 alpha-2) for the end-user

user.region

String

Two-letter region/state code (ISO 3166-1 alpha-2) for the end-user

parameters

Object

Contains end-user's preference choices

parameters.action

String

Source of the consent action: webview | click | navigate | scroll | external

parameters.configuration_tree

Object

Contains information regarding configuration tree used in the preferences widget

parameters.configuration_tree.purposes

Array of Objects

Lists purposes and their associated preferences within the configuration tree

parameters.configuration_tree.purposes.id

String

ID of the purpose

parameters.configuration_tree.purposes.name

Object

Name of the purpose in all configured translations

parameters.configuration_tree.purposes.description

Object

Description of the purpose in all configured translations

parameters.configuration_tree.purposes.enabled

Boolean

Default state of purpose as configured in the widget

parameters.configuration_tree.purposes.preferences

Array of Objects

Contains information regarding preferences associated with the parent purpose

parameters.configuration_tree.purposes.preferences.id

String

ID assigned to the preference when it is added to a configuration tree

parameters.configuration_tree.purposes.preferences.preference_id

String

ID of the preference in the preferences library

parameters.configuration_tree.purposes.preferences.name

Object

Name of the preference in all configured translations

parameters.configuration_tree.purposes.preferences.description

Object

Description of the preference in all configured translations

parameters.configuration_tree.purposes.preferences.type

String

Whether the preference is a multi-select or single select decision

parameters.configuration_tree.purposes.preferences.layoutEntityId

String

ID of the position in the preferences widget UI structure that was rendered for the preference

parameters.configuration_tree.purposes.preferences.component

Object

Contains information for the UI component used to render the preference

parameters.configuration_tree.purposes.preferences.component.id

String

Each interactive element in a widget has its own ID. This field records exactly which component instance was used — useful for tracing back to the widget design and verifying what the user was shown at the time of consent.

parameters.configuration_tree.purposes.preferences.order

Number

Position of the preference in regards to other preferences associated with the purpose

parameters.configuration_tree.purposes.preferences.metadata

Object

Free-form metadata object for the preference

parameters.configuration_tree.purposes.preferences.values

Array of Objects

Contains information for the preference values for a specific preference

parameters.configuration_tree.purposes.preferences.values.id

String

ID of the preference value

parameters.configuration_tree.purposes.preferences.values.name

Object

Name of the preference value in all configured translations

parameters.configuration_tree.purposes.preferences.values.layoutEntityId

String

ID of the position in the preferences widget UI structure that was rendered for the preference value

parameters.configuration_tree.purposes.preferences.values.enabled

Boolean

Default state of preference value as configured in the widget

parameters.configuration_tree.purposes.preferences.values.component

Object

Contains information for the UI component used to render the preference value

parameters.configuration_tree.purposes.preferences.values.component.id

String

Each interactive element in a widget has its own ID. This field records exactly which component instance was used — useful for tracing back to the widget design and verifying what the user was shown at the time of consent.

parameters.configuration_tree.purposes.preferences.values.order

Number

Position of the preference value in regards to other preferences values

parameters.configuration_tree.purposes.preferences.values.metadata

Object

Free-form metadata object for the preference

parameters.current_consents

Object

Contains current end-user preference selections

parameters.current_consents.purposes

Object

Contains current purposes and preference selections made by the end-user

parameters.current_consents.[PURPOSE _ID]

Object

Purpose that has been consented to by the end-user

parameters.current_consents.[PURPOSE_ID].id

String

ID of the purpose that has been consented to by the end-user

parameters.current_consents.[PURPOSE_ID].enabled

Boolean

Default state of purpose as configured in the widget

parameters.current_consents.[PURPOSE_ID].values

Object

Contains preference and preference values selected by the end-user

parameters.current_consents.[PURPOSE_ID].values.[PREFERENCE_ID]

Object

Contains preference value choices made

parameters.current_consents.[PURPOSE_ID].values.[PREFERENCE_ID].value

String

Choices made for preference

parameters.previous_consents

Object

Contains previous end-user preference selections

parameters.previous_consents.purposes

Object

Contains previous purposes and preference selections made by the end-user

parameters.previous_consents.purposes.[PURPOSE_ID]

Object

Purpose that has been consented to by the end-user

parameters.previous_consents.purposes.[PURPOSE_ID].id

String

ID of the purpose that has been consented to by the end-user

parameters.previous_consents.purposes.[PURPOSE_ID].enabled

Boolean

Default state of purpose as configured in the widget

parameters.previous_consents.purposes.[PURPOSE_ID].values

Object

Contains preference and preference values selected by the end-user

parameters.previous_consents.purposes.[PURPOSE_ID].values.[PREFERENCE_ID]

Object

Contains previous end-user preference selections

parameters.previous_consents.purposes.[PURPOSE_ID].values.[PREFERENCE_ID].value

String

Contains previous purposes and preference selections made by the end-user

experiment

String | null

ID of the experiment

apikey

String | null

Organization's public API key

timestamp

Number

Unique timestamp of the event

datetime

ISO-8601 Date

Date & time of the event

is_bot

String | null

Whether the event was derived from a bot action

is_domain_valid

String | null

Indicates whether the domain from which the consent event was sent was a recognized, active Didomi Privacy Center or Preference Center domain at the time the event was recorded

rate

Number | null

Sampling rate of the event

namespace

String | null

Event namespace (sdks for SDK events)

Reference: PDF glossary

Review the table below for definitions of terms found in the downloaded PDF version of a privacy record.

Tab
Field
Description

User choice

Purposes > Accepted

List of purposes where end-user has explicitly given consent for data processing

User choice

Purposes > Denied

List of purposes where end-user has explicitly denied consent for data processing

User choice

Purposes > Accepted legitimate interest

List of purposes where end-user allows legitimate interest processing

User choice

Purposes > Denied legitimate interest

List of purposes where end-user objects to legitimate interest processing

User choice

Vendors > Accepted

List of vendors where end-user has explicitly given consent for data processing

User choice

Vendors > Denied

List of vendors where end-user has explicitly denied consent for data processing

User choice

Vendors > Accepted legitimate interest

List of vendors where end-user allows legitimate interest processing

User choice

Vendors > Denied legitimate interest

List of vendors where end-user objects to legitimate interest processing

Global information

Date & Time

Date and time the event was submitted

Global information

Country

Two-letter country code and region code (ISO 3166-1 alpha-2) from where the event was submitted

Source

Domain

Domain name of the source

Source

Device

Type of source

Source

Browser

Browser from which the event was submitted (if available)

Metadata

country

Two-letter country code (ISO 3166-1 alpha-2) for the end-user

Metadata

region

Two-letter region/state code (ISO 3166-1 alpha-2) for the end-user

Metadata

id

Unique ID of the user

Metadata

id_type

Type of user ID

Metadata

id_hash

Specifies the hashing algorithm used to obscure the end-user's identifier (e.g. sha1 or sha256)

Metadata

organization_user_id

Unique user ID assigned by your organization that is used to link a Didomi end-user to your internal systems as well as resolve cross-platform IDs.

Metadata

token

JSON Web Tokens that allow users to access their consent data and update it

Metadata

authentication

Method by which end-user was authenticated

Metadata

tcfcs

TCF consent string for the end-user (if it was available or generated at the time of consent collection)

Metadata

tcfv

Version of the TCF.

Metadata

regs

Applicable regulations based on end-user location

Metadata

type

Source type for the event

Metadata

domain

The domain where the event was collected

Metadata

key

The unique key that identify the source.

Metadata

session_id

Session ID

Metadata

deployment_id

Widget/consent notice deployment id

Metadata

provider

ID of the clients which distributes API keys itself

Metadata

beacon

Indicates the value true or false. True If the event is sent by the Navigator.sendBeacon() function, otherwise false.

Metadata

version

Number of modifications made on this source.

Metadata

sampling

Sampling method used for determining events to log

Widget

Product

Didomi product associated with the event

Widget

Widget ID

ID of the widget/consent notice

Widget

Deployment ID

Widget/consent notice deployment id

Widget

Preview

Provides a visualization of the widget/consent notice displayed to the end-user

Last updated