Method: stats.getQuery

Get the query statistics for customer.

Note: This API requires a standard end user account to execute.

HTTP request

GET https://cloudsearch.googleapis.com/v1/stats/query

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 (CustomerQueryStats)
    }
  ],
  "totalQueryCount": string
}
Fields
stats[]

object (CustomerQueryStats)

totalQueryCount

string (int64 format)

Total successful query count (status code 200) for the given date range.

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.

CustomerQueryStats

JSON representation
{
  "date": {
    object (Date)
  },
  "queryCountByStatus": [
    {
      object (QueryCountByStatus)
    }
  ]
}
Fields
date

object (Date)

The date for which query stats were calculated. Stats calculated on the next day close to midnight are returned.

queryCountByStatus[]

object (QueryCountByStatus)