Configuration

The Experience API's, also referred to as Configuration API's, are a suite of API's purpose-built for retrieving zero-party data configurations to drive highly personalized and relevant customer experiences.

These API's natively support localization and specific query parameters to return custom configurations, consents, preference choices, and other data elements, giving you complete control over your customers' experiences, spanning from micro experiences to full-featured preference centers and everything in between.

These API's are classified as follows:

• Profile Configuration
• Preference Configuration

NOTE

Both MyPreferences 2.0 and 3.0 customers utilize the Configuration APIs. However, users of MyPreferences 3.0 must be cognizant about the route discrepancy when using these APIs. The Configuration API along with the Synchronization API are the only API's relevant to MyPreferences 3.0 users, and they can be accessed here.

The Bulk Export API allows you to retrieve data defined in your data segments to establish near real-time integrations between MyPreferences and other systems, support audience-building use cases, or build an internal service that receives updates at specific intervals.

In addition to retrieving data from segments in full, incremental access is also available by including “lastdatetime” when initiating the request.

The MyPreferences Import Bulk API allows you to import large sets of zero-party data, including customer profile data, preferences and consents within MyPreferences. It enables you to establish periodical imports to sync MyPreferences with customer data captured in other applications.

Workflow:
Initiate: Request to initiate an import Stage: Stage data that you want to import using the access token. Depending on the size of your request, you may make multiple requests to stage your entire dataset to import Execute: Once all the data is staged, request to execute the import Status: Check the status of your import by polling the Status endpoint using the status token Retrieve (optional): Retrieve any validation failures and exceptions using the Exceptions endpoint.

The initiate step begins the process of bulk import. Valid requests receive an HTTPS 200 - OK response including an access token. The access token is required to stage, execute, and retrieve the status of the bulk import. It is also used for retrieving records that failed to import.

This token is only active for six hours before it expires. Once expired, it cannot be used again for staging, executing, retrieving the import status or exceptions.

The staging step is the second step in the import process where the data gets staged for initial validation.

The response for each staging request also includes the total number of records received, number of records that were validated successfully, and the records that failed during the initial validation process.

The ValidationFailed count represents the number of records that failed validation during the data staging process. User permissions are also validated during the staging process.

The Staging step can be run multiple times before an import is executed to allow for a large amount of data to be built up over time as long as the access token remains active. For example, a user can initiate an import first thing in the morning and stage data multiple times over the course of several hours. When the execute request is run, all of the data that was staged will be imported into MyPreferences.

The execute step is the last step in the import process. Once all the data is staged, run the execute request to write the data from the staging area to the MyPreferences database.

Only records that are reported back as "Validation Successful" during the staging process will be imported. Any records that failed validation or got returned as exceptions will be ignored. A summary of the import details is included in the response once the execution step is completed.

Processed, Exceptions, and NotHonored count will not be available instantly upon execution. Depending on the record count, poll the the "Retrieve Status" endpoint at regular intervals until the status is returned as “Complete”.

Use this method to retrieve the current status of an import. One of the following statuses will be reported.

• Initiated - The import has been defined and is ready to accept profile records.
• Staging - The data is being staged. More records may be added at this stage.
• Queued - The import has been executed and records have been queued.
• Processing - The records in the import are being processed.
• Completed - The records have been imported.
• Failed - The import has failed to execute and none of the staged records were added into MyPreferences.

During both the staging process and import execution, exceptions may occur. These exceptions can be caused by a variety of factors such as incorrect data or email addresses that do not conform to the RegEx configured on your account. You can use this method to retrieve records that encountered exceptions during the staging process so that they can be fixed and re-staged.

Exceptions encountered during the execution phase should also be retrieved using this endpoint.