Batch export content

Multi-regulations approach is not yet compatible with the Didomi Consents API. As a result, the Cross-Device and Batch Export features can be used for GDPR only, and not for other regulations.

This article will give you more details about what information is included in the batch export, and high-level examples of use cases where batch export can be a good solution.

Batch export is a premium feature. To enable it, please reach out to our Support team.

🔎 Scope of batch export

The batch export provides a way to access all user choices (consents and preferences) collected through the Didomi platform at once, for CMP and Preference Management Platform.

Once the batch export is enabled by the Support team and properly configured, you will get the export in JSON dropped in the location configured in agreement with Didomi, every 24h.

The data is available in the export from the moment the feature is enabled (or from Consent API enablement if it is before).

Only consent-given types of events are included in the file (page views are not part of the batch export).

Data in the exported file is not sampled.

For more details regarding feature configuration, please check this documentation.

🗒️ Data definition

There are two objects with similar fields in the batch export: User and Events.

• User: last consent a user gives. In other words, the last consent status of the user.

• Events: all historical consents a user gave.

You will find below the description of each field you may find in the exported file:

💻 FIELDS	📕 DESCRIPTION
user.consents	Consents object for user
user.consents.channels	Channels (for Preference Management Platform)
user.consents.channels.id	Channel ID
user.consents.channels.enabled	User choices for the channel
user.consents.purposes	Purposes (for both CMP and Preference Management Platform)
user.consents.purposes.enabled	User choices for the purpose based on consent
user.consents.purposes.enabled_li	User choices for the purpose based on legitimate interest
user.consents.purposes.id	Purpose ID
user.consents.purposes.preferences	Preferences (for Preference Management Platform)
user.consents.purposes.preferences.id	Preference ID
user.consents.purposes.preferences.enabled	User choices for the preference
user.consents.purposes.preferences.channels	Channels linked to purpose and preference (for Preference Management Platform)
user.consents.purposes.preferences.channels.id	Channel ID linked to purpose and preference
user.consents.purposes.preferences.channels.enabled	User choices for the channel linked to the purpose and preference
user.consent.tcfs	TCF consent string generated by the user (for CMP)
user.consents.vendors	Vendors object
user.consents.vendors.disabled	List of vendors disabled by the user based on consent
user.consents.vendors.disabled_li	List of vendors disabled by the user based on legitimate interest
user.consents.vendors.enabled	List of vendors enabled by the user based on consent
user.consents.vendors.enabled_li	List of vendors enabled by the user based on legitimate interest
user.country	Country of the user (always set by the client, null otherwise)
user.created_at	Creation date of the user
user.delegate	Information of the client's employee for signed consent (for Preference Management Platform)
user.id	Didomi's user ID
user.last_seen_country	User country based on his last known connexion location
user.metadata	Metadata of user, defined by the customer
user.organization_id	Didomi's organization ID
user.organization_user_id	Organization user id (usually equal to an ID on the customer side)
user.organization_user_id_type	Type of organization user id (email, ...)
user.proofs_id	Id of proof document (for Preference Management Platform). Always null for user
user.source	Source of event. Always null for user object
user.status	Status of the user. Always null for user object
user.updated_at	Consent update date
user.validation	Payload for double opt-in consents (for Preference Management Platform)
user.version	Number of modifications made to the user
events.consents	Consents object for the event
events.consents.channels	Channels (for Preference Management Platform)
events.consents.channels.id	Channel ID
events.consents.channels.enabled	User choices for the channel
events.consents.purposes	Purposes (for both CMP and Preference Management Platform)
events.consents.purposes.enabled	User choices for the purpose based on consent
events.consents.purposes.enabled_li	User choices for the purpose based on legitimate interest
events.consents.purposes.id	Purpose ID
events.consents.purposes.preferences	Preferences (for Preference Management Platform)
events.consents.purposes.preferences.id	Preference ID
events.consents.purposes.preferences.enabled	User choices for the preference
events.consents.purposes.preferences.channels	Purposes (for Preference Management Platform)
events.consents.purposes.preferences.channels.id	Channel ID linked to the purpose and preference
events.consents.purposes.preferences.channels.enabled	User choice for the channel linked to the purpose and preference
events.consents.tcfcs	TCF consent string generated by the user (for CMP)
events.consents.vendors	Vendors object
events.consents.vendors.disabled	List of vendors disabled by the user based on consent
events.consents.vendors.disabled_li	List of vendors disabled by the user based on legitimate interest
events.consents.vendors.enabled	List of vendors enabled by the user based on consent
events.consents.vendors.enabled_li	List of vendors enabled by the user based on legitimate interest
events.country	Country of the user (always set by the client, null otherwise)
events.created_at	Creation date of the event
events.delegate	Information of the client's employee for signed consent (for Preference Management Platform)
events.id	Event ID
events.last_seen_country	User country based on his last known connexion location
events.metadata	Metadata of user, defined by the customer
events.organization_id	Didomi's organization ID
events.proofs_id	Id of proof document (for Preference Management Platform). Always null for user
events.source	Source of event (for example SDK web...)
events.status	Status of the user.
events.updated_at	Consent update date
events.user	User object for the event
events.user.organization_user_id	Organization user id (usually equal to an ID on the customer side)
events.user.id	Didomi's user ID
events.user.metadata	Metadata of user, defined by the customer
events.validation	Payload for double opt-in consents (for Preference Management Platform)
events.version	Number of modifications made to the user

👍 Batch export use cases

Batch export can be useful for the following use cases:

• Compute consent metrics (dedicated documentation in progress) or metrics that are not provided by Didomi

• Cross consent data with business data

• Centralize or back up user choices in your system

• Reconcile data between you and Didomi (based on organization_user_id)

• Integrate data in your business tools (CRMs, marketing automation, etc.)

• Get proof of consent in case of complaints