Gets a list of user events within a time range, with potential filtering. The method does not list unjoined user events.
Unjoined user event definition: when a user event is ingested from Recommendations AI User Event APIs, the catalog item included in the user event is connected with the current catalog. If a catalog item of the ingested event is not in the current catalog, it could lead to degraded model quality. This is called an unjoined event.
HTTP request
GET https://recommendationengine.googleapis.com/v1beta1/{parent=projects/*/locations/*/catalogs/*/eventStores/*}/userEvents
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
parent |
Required. The parent eventStore resource name, such as Authorization requires the following IAM permission on the specified resource
|
Query parameters
Parameters | |
---|---|
pageSize |
Optional. Maximum number of results to return per page. If zero, the service will choose a reasonable default. |
pageToken |
Optional. The previous ListUserEventsResponse.next_page_token. |
filter |
Optional. Filtering expression to specify restrictions over returned events. This is a sequence of terms, where each term applies some kind of a restriction to the returned user events. Use this expression to restrict results to a specific time range, or filter events by eventType. eg: eventTime > "2012-04-23T18:25:43.511Z" eventsMissingCatalogItems eventTime<"2012-04-23T18:25:43.511Z" eventType=search We expect only 3 types of fields:
Some examples of valid filters expressions:
|
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
Response message for userEvents.list method.
JSON representation | |
---|---|
{
"userEvents": [
{
object ( |
Fields | |
---|---|
userEvents[] |
The user events. |
nextPageToken |
If empty, the list is complete. If nonempty, the token to pass to the next request's userEvents.list.page_token. |
Authorization Scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.