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:

JSON representation
{
  "stats": [
    {
      object (CustomerSessionStats)
    }
  ]
}
Fields
stats[]

object (CustomerSessionStats)

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud_search.stats.indexing
  • https://www.googleapis.com/auth/cloud_search.stats
  • https://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