Data Repair API
The Data Repair API provides you with a way to delete or edit your existing Adobe Analytics data. The API offers you the ability to delete columns of data. Filters provide options for you to target specific values within a data column to make precise adjustments to your data. If you use Adobe Experience Platform, repairs made to your Adobe Analytics data are also reflected in any data you send to the Adobe Experience Platform Data Lake through the Analytics Data Connector.
While most data types and variables are available to repair or delete through this API, note that events/metrics, merchandising variables, and some other variable types are not available. Review the Job definition reference for a detailed list of the variables supported by the Data Repair API.
Use of the Data Repair API permanently deletes or edits existing Adobe Analytics data. Adobe recommends that you take a careful approach when executing Data Repair API jobs to minimize accidental deletion or alteration of your data. Read through all pages of this guide carefully before using the Data Repair API.
Adobe may add optional request and response members (name/value pairs) to existing API objects at any time and without notice or changes in versioning. Adobe recommends that you refer to the API documentation of any third-party tool you integrate with our APIs so that such additions are ignored in processing if not understood. If implemented properly, such additions are non-breaking changes for your implementation. Adobe will not remove parameters or add required parameters without first providing standard notification through release notes.
Prerequisites
Before using the Data Repair API, make sure that all the following prerequisites are met:
Confirm that your Sales Order includes the use of the Data Repair API. The Data Repair API is a paid service. Reach out to your Adobe Account Team for details and confirmation of your status.
You can successfully authenticate with the Adobe Analytics 2.0 API. See Getting started with the Analytics API to make sure that you have the correct API permissions in the Adobe Admin Console, create an API client on Adobe Developer, and that you successfully authenticate. Make sure that you include the "Data Repair API" permission item when creating a product profile in the Adobe Admin Console.
Fix any implementation errors that may be causing unwanted data to be collected
Workflow
Adobe recommends a careful and methodical approach when using the Data Repair API due to its ability to permanently delete or edit your data. The following steps provide multiple checkpoints to minimize the risk of accidental data deletion. Review the data after each step to confirm that the data repair job completes as expected. Adobe recommends that you create a data repair job for each of the following in order:
- A development Report Suite for one day of data, ideally the first day in the desired range.
- A development Report Suite for one month of data.
- The production Report Suite for one day of data, ideally the first day in the desired range.
- The production Report Suite for one month of data.
- Once all of your testing and validation is complete, you can proceed with the full date range of the data repair for production data.
The following steps provide a typical Data Repair API request workflow:
Estimate repair size: The Data Repair API incurs charges based on the number of Data Rows Scanned. The Server call estimate endpoint is a required step to help you estimate the cost of a repair. It returns a count of the Server Call volume for the Report Suite date range. The endpoint also returns a
validationToken, which is required for step 2.Create a data repair job: Use the Job endpoint to create a data repair job. This endpoint requires a Report Suite, date range,
validationToken(from Server call estimate), and a Job definition. A Job ID is returned when a data repair job is created.Monitor progress: Use the Job ID endpoint to monitor the status of a data repair job at any point after a data repair job submission. Completion time of a data repair job depends on its size; small jobs can complete within hours while large jobs can take multiple days.
Review completed jobs: Use the Job list endpoint to keep track of all existing and completed jobs.
