Data Hygiene API guide

The Data Hygiene API allows you to programmatically correct or delete your customers’ stored personal data in Adobe Experience Platform, as well as schedule expiration dates for datasets. This guide covers the prerequisite steps to using the API and provides links to more endpoint-specific documentation.

Getting started

You can access the Data Hygiene API through the following root path: https://platform.adobe.io/data/core/hygiene/

This sections below outline the core concepts you need to know before attempting to make calls to the API.

Gather values for required headers

In order to make calls to the Data Hygiene API, you must first gather your authentication credentials. Follow the API authentication guide to generate values for each of the required headers for the Data Hygiene API, as shown below:

All requests that contain a payload (POST, PUT, PATCH) require an additional header:

Reading sample API calls

This document provides an example API call to demonstrate how to format your requests. For information on the conventions used in documentation for sample API calls, see the section on how to read example API calls in the getting started guide for Experience Platform APIs.

Dataset expirations

A dataset expiration is a time-delayed “delete a dataset” action. By creating a dataset expiration, you are specifying a future time at which that dataset should be deleted. See the dataset expiration endpoint guide for details on scheduling dataset expirations in the API.

Record deletes

The Data Hygiene API allows you delete all records associated with a identity across one or all datasets. All data lifecycle tasks that delete identities are repesented by a construct called a work order. See the work order endpoint guide for details on working with record deletes in the API.

Quota

Your organization is limited to a predetermined monthly job quota for each type of data lifecycle operation, which can vary depending on licensing. See the quota endpoint guide for details on viewing the current quota status of your data lifecycle processes.

Next steps

This guide covered how to manage data lifecycle requests using API calls. For information on how to perform these actions in the Platform UI, see the data lifecycle UI guide.