Deliver a request to delete all data associated with a user identity for the given site. This can be used to fulfill a data subject's right to delete their personal data under the GDPR. Note: This will not prevent future data collection of the subject. This can be controlled with opting out and consent.
Deleting all data for a given user may take some time to complete. You can track the status of all delete jobs using /personal/deleterequest/read.
We will store one unique entry for each delete request. In other words, the same userId can have multiple entries for the same siteId. This is to ensure that before each delete request, all data is processed appropriately.
Request
The request object has the following fields:
|
Name |
Type |
Required |
Description |
|---|---|---|---|
|
|
String |
Yes |
The type of the user identifier, which tells us how to interpret the id. The value /traffic/data , a site-specific id obtained from from our SDK . Customer-specific identifiers via a customer-assigned prefix are also possible. See our wiki article " User identities demystified " for more information. |
|
|
String |
Yes |
Identifies the user whose user data should be removed. |
|
|
String |
No |
Id key for site from which data should be deleted. Use this field if you want to delete user data for only one site. |
|
|
String |
No |
Id key for sitegroup from which data should be deleted. Use this field if you want to delete user data for only one sitegroup. |
Only one or zero of siteId and siteGroupId can be specified in a single request. A request with neither siteId or siteGroupId will delete user data across all sites that belong to your customer id. See examples below for valid use cases.
Response
On success, the return is a structured JSON object containing a unique integer identifier for the request.
Examples
# Delete user data for the specified user from one site
$ python cx.py /personal/deleterequest/create '{"userId":"134483293348982983x7","type":"ada","siteId":"310293812093123"}'
{
"id":123123018
}
# Delete user data for the specified user from all sites in one site group
$ python cx.py /personal/deleterequest/create '{"userId":"134483293348982983x7","type":"ada","siteGroupId":"421324923184236"}'
{
"id":123123019
}
# Delete user data for the specified user from all sites in all site groups
$ python cx.py /personal/deleterequest/create '{"userId":"134483293348982983x7","type":"ada"}'
{
"id":123123020
}
# Invalid - only specify one of siteGroupId and siteId
$ python cx.py /personal/deleterequest/create '{"userId":"134483293348982983x7","type":"ada","siteId":"310293812093123", "siteGroupId":"421324923184236"}'
{
"error": "At most one of siteId and siteGroupId must be specified"
}