Method: stats.getSession
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:
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 2024-09-03 UTC.
[null,null,["Last updated 2024-09-03 UTC."],[[["Retrieve query statistics such as the number of search sessions and the percentage of successful sessions with a click for a customer."],["Requires a standard end user account and uses the `GET https://cloudsearch.googleapis.com/v1/stats/session` HTTP request."],["Specify a date range using the `fromDate` and `toDate` query parameters for retrieving session statistics within that period."],["The response includes an array of `CustomerSessionStats` objects containing the date and the corresponding search session count."],["Authorization requires specific OAuth scopes like `https://www.googleapis.com/auth/cloud_search.stats.indexing` or others mentioned in the documentation."]]],[]]
