Method: projects.locations.collections.engines.sessions.list
Stay organized with collections
Save and categorize content based on your preferences.
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 comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * userPseudoId * state * displayName * starred * isPinned * labels * createTime * updateTime Examples:
userPseudoId = some_iddisplayName = "some_name"starred = trueisPinned=true AND (NOT labels:hidden)createTime > "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:
updateTimecreateTimesession_nameisPinned Example:
- "updateTime desc"
- "createTime"
- "isPinned desc,updateTime desc": list sessions by isPinned first, then by updateTime.
|
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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-07-30 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-07-30 UTC."],[[["This page details how to list all Sessions associated with a specific DataStore using the Discovery Engine API."],["The HTTP request to retrieve sessions is a `GET` request to a URL that includes the parent DataStore's resource name."],["You can filter the list of sessions using query parameters such as `pageSize`, `pageToken`, `filter`, and `orderBy`, with the maximum `pageSize` value being 1000."],["The request body must be empty, and a successful response will include a `ListSessionsResponse` object."],["Listing sessions requires the `discoveryengine.sessions.list` IAM permission and the `https://www.googleapis.com/auth/cloud-platform` OAuth scope."]]],[]]
