Anonymization API

The General Data Protection Act of the European Union guarantees consumers the right to erasure of personal data ("the right to be forgotten")—users might want their data to be deleted. This endpoint provides you the means to fulfill such requests.

The Anonymization API enables you to:

PUT anonymization job

Creates a user session anonymization job. The job anonymizes all user sessions in the specified time frame masking the user ID (userID) and IP address (ips).

To identify user sessions to be anonymized, you can specify either the user ID, IP address, or both. If you specify both, OR logic applies—every session of the specified user ID(s) gets anonymized, regardless of the IP address it came from; every session from the specified IP address gets anonymized, even if it belongs to a user ID that has not been specified. You can specify multiple user IDs and IP addresses.

Regardless of how you identify user sessions, both the user ID and IP address are masked. You can't undo anonymization.

The request produces application/json. The response body contains the ID of the anonymization job, which you can use to check the job status.

  • Managed https://{your-domain}/e/{your-environment-id}/api/v1/anonymize/anonymizationJobs
  • SaaS https://{your-environment-id}

GET anonymization job status

Checks the status of an anonymization job. The response contains the percentage of job progress.

The request produces application/json.

  • Managed https://{your-domain}/e/{your-environment-id}/api/v1/anonymize/anonymizationJobs/{requestId}
  • SaaS https://{your-environment-id}{requestId}