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.

GET	Managed	`https://{your-domain}/e/{your-environment-id}/api/v1/anonymize/anonymizationJobs/{requestId}`
	SaaS	`https://{your-environment-id}.live.dynatrace.com/api/v1/anonymize/anonymizationJobs/{requestId}`
	Environment ActiveGate	`https://{your-activegate-domain}/e/{your-environment-id}/api/v1/anonymize/anonymizationJobs/{requestId}`

Authentication

To execute this request, you need an access token with Anonymize user session data for data privacy reasons (UserSessionAnonymization) scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

Parameter	Type	Description	In	Required
requestId	string	The ID of the required anonymization job.	path	required

Response

Response codes

Code	Type	Description
200	AnonymizationProgressResult	Success. The response body contains the status of the anonymization job.
400	-	Failed. The input is invalid. See the response body for details.

Response body objects

The `AnonymizationProgressResult` object

Element Type Description

progress

integer

Element	Type	Description
progress	integer	The progress of the anonymization job, percent. -1 if the job is waiting for execution. Can be `null`.

The progress of the anonymization job, percent.

-1 if the job is waiting for execution.

Can be null.

Response body JSON model

json
{
  "progress": 50
}

Example

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

shell
curl -X GET \
    https://mySampleEnv.live.dynatrace.com/api/v1/anonymize/anonymizationJobs/7810238295331327902 \
    -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

Request URL

plaintext
https://mySampleEnv.live.dynatrace.com/api/v1/anonymize/anonymizationJobs/7810238295331327902

Response content

json
{
  "progress": 100
}

Response code

200