GET Deletion Requests
GET https://amplitude.com/api/2/deletions/users?start_day=&end_day=
Retrieves a list list deletion jobs scheduled in a time range; this time range should include the date you made the request on plus 30 days. For example, you made a deletion request on August 1st, 2018. Your deletion request should have start_day = 2018-08-01 and end_day = 2018-08-31.
If the request returns no values, then no jobs are scheduled for that time range. Note: The largest permitted time range is six months.
Response Object
The response for a GET request contains the following fields:
| key | description |
|---|---|
day | The day the deletion job is scheduled to begin |
status | The deletion job's status. Staging: The job hasn't started, and can be modified. More deletion requests may get scheduled into this job and you can remove requests from this job. Submitted: The job is submitted to run. It can't be modified. Done: The job has finished running. It can't be modified. |
amplitude_ids | List of the Amplitude Ids of users to delete. |
app | Project/app id. Appears if the deletion is applies to multiple projects. |
The amplitude_ids key contains these fields:
| key | description |
|---|---|
amplitude_id | The Amplitude ID of the user to be deleted. |
requester | The person who requested the Amplitude ID to be deleted |
requested_on_day | The day this deletion was requested |
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
start_day | null | Required. YYYY-MM-DD format. Start day to query for deletion jobs. | |
end_day | null | Required. YYYY-MM-DD format. End day to query for deletion jobs. |
RESPONSES
status: OK
[{"amplitude_ids":[{"amplitude_id":356896327775,"requested_on_day":"2022-02-17","requester":"employee@yourcompany.com"}],"day":"2022-03-03","status":"staging"}]