Method: projects.locations.collections.engines.sessions.list

Lists all Sessions by their parent DataStore.

HTTP request

GET https://discoveryengine.googleapis.com/v1/{parent=projects/*/locations/*/collections/*/engines/*}/sessions

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The data store resource name. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStoreId}

Query parameters

Parameters
pageSize

integer

Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
pageToken

string

A page token, received from a previous sessions.list call. Provide this to retrieve the subsequent page.
filter

string

A filter to apply on the list results. The supported features are: userPseudoId, state.

Example: "userPseudoId = some_id"
orderBy

string

A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * updateTime * createTime * session_name

Example: "updateTime desc" "createTime"

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of ListSessionsResponse.

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.sessions.list

For more information, see the IAM documentation.