Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To test a filter, use the list command first.
HTTP request
POST https://discoveryengine.googleapis.com/v1alpha/{parent=projects/*/locations/*/dataStores/*}/userEvents:purge
Required. The resource name of the catalog under which the events are created. The format is projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}.
Request body
The request body contains data with the following structure:
JSON representation
{"filter": string,"force": boolean}
Fields
filter
string
Required. The filter string to specify the events to be deleted with a length limit of 5,000 characters. The eligible fields for filtering are:
userPseudoId: Double quoted string. Specifying this will delete all events associated with a visitor.
userId: Double quoted string. Specifying this will delete all events associated with a user.
Note: This API only supports purging a max range of 30 days.
Examples:
Deleting all events in a time range: eventTime > "2012-04-23T18:25:43.511Z"
eventTime < "2012-04-23T18:30:43.511Z"
Deleting specific eventType in a time range: eventTime > "2012-04-23T18:25:43.511Z"
eventTime < "2012-04-23T18:30:43.511Z" eventType = "search"
Deleting all events for a specific visitor in a time range: eventTime > "2012-04-23T18:25:43.511Z"
eventTime < "2012-04-23T18:30:43.511Z" userPseudoId = "visitor1024"
Deleting the past 30 days of events inside a DataStore: *
The filtering fields are assumed to have an implicit AND.
force
boolean
The force field is currently not supported. Purge user event requests will permanently delete all purgeable events. Once the development is complete: If force is set to false, the method will return the expected purge count without deleting any user events. This field will default to false if not included in the request.
Response body
If successful, the response body contains an instance of Operation.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-27 UTC."],[[["This API operation permanently deletes user events based on a provided filter, which can take a significant amount of time to complete depending on the number of events."],["The HTTP request is a `POST` operation to the specified URL, using gRPC Transcoding syntax, and requires a `parent` path parameter indicating the resource name of the data store."],["The request body accepts a JSON structure containing a `filter` string to specify events for deletion and a `force` boolean field (currently not supported)."],["The `filter` string supports filtering by `eventType`, `eventTime`, `userPseudoId`, and `userId`, with a maximum length of 5,000 characters and a 30-day time range limit."],["The operation requires the OAuth scope `https://www.googleapis.com/auth/cloud-platform` and the IAM permission `discoveryengine.userEvents.purge` on the parent resource."]]],[]]
