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/*/collections/*/dataStores/*}/userEvents:purge
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
parent |
Required. The resource name of the catalog under which the events are created. The format is |
Request body
The request body contains data with the following structure:
JSON representation |
---|
{ "filter": string, "force": boolean } |
Fields | |
---|---|
filter |
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:
Note: This API only supports purging a max range of 30 days. Examples:
The filtering fields are assumed to have an implicit AND. |
force |
The |
Response body
If successful, the response body contains an instance of Operation
.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
IAM Permissions
Requires the following IAM permission on the parent
resource:
discoveryengine.userEvents.purge
For more information, see the IAM documentation.