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

Lists all Sessions by their parent DataStore.

HTTP request

GET https://discoveryengine.googleapis.com/v1alpha/{parent=projects/*/locations/*/collections/*/dataStores/*}/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 comma-separated list of fields to filter by, in EBNF grammar.

The supported fields are:

  • user_pseudo_id
  • state
  • display_name
  • starred
  • is_pinned
  • labels
  • create_time
  • update_time

Examples:

  • user_pseudo_id = some_id
  • display_name = "some_name"
  • starred = true
  • is_pinned=true AND (NOT labels:hidden)
  • create_time > "1970-01-01T12:00:00Z"
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:

  • update_time
  • create_time
  • session_name
  • is_pinned

Example:

  • update_time desc
  • create_time
  • is_pinned desc,update_time desc: list sessions by is_pinned first, then by update_time.

Request body

The request body must be empty.

Response body

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

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.assist.readwrite

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.