Method: stats.getSession
Stay organized with collections
Save and categorize content based on your preferences.
Get the # of search sessions, % of successful sessions with a click query statistics for customer.
Note: This API requires a standard end user account to execute.
HTTP request
GET https://cloudsearch.googleapis.com/v1/stats/session
The URL uses gRPC Transcoding syntax.
Query parameters
| Parameters |
fromDate |
object (Date)
All available stats from fromDate to toDate are returned. fromDate should be within the year and toDate >= fromDate.
|
toDate |
object (Date)
|
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
| Fields |
stats[] |
object (CustomerSessionStats)
|
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/cloud_search.stats.indexinghttps://www.googleapis.com/auth/cloud_search.statshttps://www.googleapis.com/auth/cloud_search
For more information, see the Authorization guide.
CustomerSessionStats
| JSON representation |
{
"date": {
object (Date)
},
"searchSessionsCount": string
} |
| Fields |
date |
object (Date)
The date for which session stats were calculated. Stats are calculated on the following day, close to midnight PST, and then returned.
|
searchSessionsCount |
string (int64 format)
The count of search sessions on the day
|
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-04-04 UTC.
[null,null,["Last updated 2025-04-04 UTC."],[],[],null,["# Method: stats.getSession\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.GetCustomerSessionStatsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [CustomerSessionStats](#CustomerSessionStats)\n - [JSON representation](#CustomerSessionStats.SCHEMA_REPRESENTATION)\n- [Try it!](#try-it)\n\nGet the # of search sessions, % of successful sessions with a click query statistics for customer.\n\n**Note:** This API requires a standard end user account to execute.\n\n### HTTP request\n\n`GET https://cloudsearch.googleapis.com/v1/stats/session`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `fromDate` | `object (`[Date](/workspace/cloud-search/docs/reference/rest/v1/Date)`)` All available stats from fromDate to toDate are returned. fromDate should be within the year and toDate \\\u003e= fromDate. |\n| `toDate` | `object (`[Date](/workspace/cloud-search/docs/reference/rest/v1/Date)`)` |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"stats\": [ { object (/workspace/cloud-search/docs/reference/rest/v1/stats/getSession#CustomerSessionStats) } ] } ``` |\n\n| Fields ||\n|-----------|---------------------------------------------------------------------------------------------------------------------------|\n| `stats[]` | `object (`[CustomerSessionStats](/workspace/cloud-search/docs/reference/rest/v1/stats/getSession#CustomerSessionStats)`)` |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/cloud_search.stats.indexing`\n- `https://www.googleapis.com/auth/cloud_search.stats`\n- `https://www.googleapis.com/auth/cloud_search`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent).\n\nCustomerSessionStats\n--------------------\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------|\n| ``` { \"date\": { object (/workspace/cloud-search/docs/reference/rest/v1/Date) }, \"searchSessionsCount\": string } ``` |\n\n| Fields ||\n|-----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `date` | `object (`[Date](/workspace/cloud-search/docs/reference/rest/v1/Date)`)` The date for which session stats were calculated. Stats are calculated on the following day, close to midnight PST, and then returned. |\n| `searchSessionsCount` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` The count of search sessions on the day |"]]
