Anonymization API - GET job status

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

The request produces an application/json payload.

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


To execute this request, you need the Anonymize user session data for data privacy reasons (UserSessionAnonymization) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.


Parameter Type Description In Required
requestId string

The ID of the required anonymization job.

path required


Response codes

Code Description

Success. The response body contains the status of the anonymization job.


Failed. The input is invalid. See the response body for details.

Response body

The AnonymizationProgressResult object

Element Type Description
progress integer

The progress of the anonymization job, percent.

-1 if the job is waiting for execution.


In this example, the request checks the status of the anonymization job with the ID of 7810238295331327902.

The API token is passed in the Authorization header.

The response shows that the job is complete.


curl -X GET \ \
    -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

Request URL

Response content

  "progress": 100

Response code