REST Resource: stats.index.datasources
Stay organized with collections
Save and categorize content based on your preferences.
Resource: GetDataSourceIndexStatsResponse
| JSON representation |
{
"stats": [
{
object (DataSourceIndexStats)
}
],
"averageIndexedItemCount": string
} |
| Fields |
stats[] |
object (DataSourceIndexStats)
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.
|
DataSourceIndexStats
Aggregation of items by status code as of the specified date.
| JSON representation |
{
"date": {
object (Date)
},
"itemCountByStatus": [
{
object (ItemCountByStatus)
}
]
} |
| Fields |
date |
object (Date)
The date for which index stats were calculated. If the date of request is not the current date then stats calculated on the next day are returned. Stats are calculated close to mid night in this case. If date of request is current date, then real time stats are returned.
|
itemCountByStatus[] |
object (ItemCountByStatus)
Number of items aggregrated by status code.
|
ItemCountByStatus
| JSON representation |
{
"statusCode": enum (ItemStatus.Code),
"count": string,
"indexedItemsCount": string
} |
| Fields |
statusCode |
enum (ItemStatus.Code)
Status of the items.
|
count |
string (int64 format)
Number of items matching the status code.
|
indexedItemsCount |
string (int64 format)
Number of items matching the status code for which billing is done. This excludes virtual container items from the total count. This count would not be applicable for items with ERROR or NEW_ITEM status code.
|
Methods |
|
|
Gets indexed item statistics for a single data source. |
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-03-24 UTC.
[null,null,["Last updated 2025-03-24 UTC."],[],[],null,["# REST Resource: stats.index.datasources\n\n- [Resource: GetDataSourceIndexStatsResponse](#GetDataSourceIndexStatsResponse)\n - [JSON representation](#GetDataSourceIndexStatsResponse.SCHEMA_REPRESENTATION)\n- [DataSourceIndexStats](#DataSourceIndexStats)\n - [JSON representation](#DataSourceIndexStats.SCHEMA_REPRESENTATION)\n- [ItemCountByStatus](#ItemCountByStatus)\n - [JSON representation](#ItemCountByStatus.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: GetDataSourceIndexStatsResponse\n-----------------------------------------\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"stats\": [ { object (/workspace/cloud-search/docs/reference/rest/v1/stats.index.datasources#DataSourceIndexStats) } ], \"averageIndexedItemCount\": string } ``` |\n\n| Fields ||\n|---------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `stats[]` | `object (`[DataSourceIndexStats](/workspace/cloud-search/docs/reference/rest/v1/stats.index.datasources#DataSourceIndexStats)`)` Summary of indexed item counts, one for each day in the requested range. |\n| `averageIndexedItemCount` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Average item count for the given date range for which billing is done. |\n\nDataSourceIndexStats\n--------------------\n\nAggregation of items by status code as of the specified date.\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"date\": { object (/workspace/cloud-search/docs/reference/rest/v1/Date) }, \"itemCountByStatus\": [ { object (/workspace/cloud-search/docs/reference/rest/v1/stats.index.datasources#ItemCountByStatus) } ] } ``` |\n\n| Fields ||\n|-----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `date` | `object (`[Date](/workspace/cloud-search/docs/reference/rest/v1/Date)`)` The date for which index stats were calculated. If the date of request is not the current date then stats calculated on the next day are returned. Stats are calculated close to mid night in this case. If date of request is current date, then real time stats are returned. |\n| `itemCountByStatus[]` | `object (`[ItemCountByStatus](/workspace/cloud-search/docs/reference/rest/v1/stats.index.datasources#ItemCountByStatus)`)` Number of items aggregrated by status code. |\n\nItemCountByStatus\n-----------------\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"statusCode\": enum (/workspace/cloud-search/docs/reference/rest/v1/ItemStatus.Code), \"count\": string, \"indexedItemsCount\": string } ``` |\n\n| Fields ||\n|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `statusCode` | `enum (`[ItemStatus.Code](/workspace/cloud-search/docs/reference/rest/v1/ItemStatus.Code)`)` Status of the items. |\n| `count` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Number of items matching the status code. |\n| `indexedItemsCount` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Number of items matching the status code for which billing is done. This excludes virtual container items from the total count. This count would not be applicable for items with ERROR or NEW_ITEM status code. |\n\n| Methods ------- ||\n|---------------------------------------------------------------------------------------|--------------------------------------------------------|\n| ### [get](/workspace/cloud-search/docs/reference/rest/v1/stats.index.datasources/get) | Gets indexed item statistics for a single data source. |"]]
