Method: projects.locations.catalogs.eventStores.userEvents.purge

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://recommendationengine.googleapis.com/v1beta1/{parent=projects/*/locations/*/catalogs/*/eventStores/*}/userEvents:purge

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The resource name of the event_store under which the events are created. The format is projects/${projectId}/locations/global/catalogs/${catalogId}/eventStores/${eventStoreId}

Authorization requires the following IAM permission on the specified resource parent:

  • automlrecommendations.events.purge

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. Empty string filter is not allowed. The eligible fields for filtering are:

  • eventType: UserEvent.eventType field of type string.
  • eventTime: in ISO 8601 "zulu" format.
  • visitorId: field of type string. Specifying this will delete all events associated with a visitor.
  • userId: field of type string. Specifying this will delete all events associated with a user.

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 time range: eventTime > "2012-04-23T18:25:43.511Z" eventType = "detail-page-view"
  • Deleting all events for a specific visitor: visitorId = "visitor1024"

The filtering fields are assumed to have an implicit AND.
force

boolean

Optional. The default value is false. Override this flag to true to actually perform the purge. If the field is not set to true, a sampling of events to be deleted will be returned.

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.