How can data hygiene API be used to correct customer data

[arpan-garg]

Hi Community members,

On the document https://experienceleague.adobe.com/en/docs/experience-platform/data-lifecycle/api/overview its mentioned that data hygiene API be used to correct customer data. However i found no api which allow you to correct the data.

Is there really a data hygiene api which allows you to do so? Or the idea is just to re-ingest the correct data in the profile.

Thanks,

Arpan

[Rite18]

@arpan-garg my understanding is, it is more data of correction  via ingesting data again with the correct value, in terms of deletion I see a note on the given link as below 

Record delete requests are only available for organizations that have purchased Adobe Healthcare Shield.

[arpan-garg]

Hi @Rite18 - I have the same understanding, since its mentioned that data hygiene API is also used to correct data, i was under the impression there is some other api to do that which is not mentioned.

[brekrut]

Hello @arpan-garg / @Rite18 

The Data Hygiene module allows for the option to delete individual profiles against specific datasets or all datasets.  The other feature allows for the programatic setting of TTL upon dataSets.

If you are looking to clean up records, then @arpan-garg you are correct, data would have to be re-ingested or modified using query service to write data upon the record dataset.

[Rudi-Shumpert]

From the AI Assistant:

The Data Hygiene API in Adobe Experience Platform can be used to correct customer data through programmatic deletions of consumer records and datasets. This capability allows you to ensure that information is used as expected, updated when incorrect, and deleted when organizational policies deem it necessary.¹²

To use the Data Hygiene API to correct customer data, you can follow these steps:¹

1. Understand the Data Hygiene API: Read the Data Hygiene API reference document for detailed information on how to use the API. This document includes the available endpoints, request parameters, and response formats to help you efficiently manage your stored customer data.²

2. Programmatic Corrections: Use the Data Hygiene API to schedule dataset expiration dates, programmatically correct or delete stored customer personal data, and check your data hygiene quotas. This allows you to ensure that customer data is updated when incorrect and is in compliance with organizational policies.¹³

3. Work Order Creation: You can use the /workorder endpoint in the Data Hygiene API to programmatically manage record delete requests in Experience Platform. With this endpoint, you can create a delete request, check on its status, or update an existing request. By following the guidelines for optimizing cleanup request submissions, you can efficiently and systematically process data corrections.⁴¹

By leveraging the Data Hygiene API, you can proactively manage and correct customer data to ensure its accuracy and compliance with organizational policies.²

Hide sources

Sources

1. Data Hygiene API Guide: DocumentationExperience,endpoint-specificdocumentation 
2. Adobe Experience Platform Release Notes July 2024: Advanced data lifecycle,lifecycle... 
3. Perform data hygiene operations: DocumentationJourney,5d-9208-48f4-b874-1cefb8df4d76 
4. Best Practices for Advanced Data Lifecycle Management: Work order creation... 

[arpan-garg]

Hi @Rudi-Shumpert  - Thanks for sharing this.

In regards to the second point "the Data Hygiene API to schedule dataset expiration dates, programmatically correct or delete stored customer personal data, and check your data hygiene quotas. This allows you to ensure that customer data is updated when incorrect and is in compliance with organizational policies.¹³" I can't find anything to programatically correct it , especially within the documents provided.

[dwright]

@arpan-garg ,

I agree with you. I am only familiar of Data Hygiene (or Data Lifecycle Management) being used to delete datasets and records. I have opened this git issue so the docs team can investigate and correct the article, if needed: https://github.com/AdobeDocs/experience-platform.en/issues/408

[arpan-garg]

Thanks @dwright