Method: stats.getIndex

Gets indexed item statistics aggreggated across all data sources. This API only returns statistics for previous dates; it doesn't return statistics for the current day.

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

HTTP request

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

The URL uses gRPC Transcoding syntax.

Query parameters

Parameters
fromDate

object (Date)

Start of the date range to retrieve statistics for. This value must be within 1 year of the current date.

toDate

object (Date)

End of the date range to retrieve statistics for. This value must be within 1 year of the current date and greater than fromDate.

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

object (CustomerIndexStats)

Summary of indexed item counts, one for each day in the requested range.

averageIndexedItemCount

string (int64 format)

Average item count for the given date range for which billing is done.

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 OAuth 2.0 Overview.

CustomerIndexStats

Aggregation of items by status code as of the specified date.

JSON representation
{
  "date": {
    object (Date)
  },
  "itemCountByStatus": [
    {
      object (ItemCountByStatus)
    }
  ]
}
Fields
date

object (Date)

Date for which statistics were calculated.

itemCountByStatus[]

object (ItemCountByStatus)

Number of items aggregrated by status code.