Cloud Search API . stats . index . datasources

close()

Close httplib2 connections.

get(name, fromDate_day=None, fromDate_month=None, fromDate_year=None, toDate_day=None, toDate_month=None, toDate_year=None, x__xgafv=None)

Gets indexed item statistics for a single data source. **Note:** This API requires a standard end user account to execute.

Args:
  name: string, The resource id of the data source to retrieve statistics for, in the following format: "datasources/{source_id}" (required)
  fromDate_day: integer, Day of month. Must be from 1 to 31 and valid for the year and month.
  fromDate_month: integer, Month of date. Must be from 1 to 12.
  fromDate_year: integer, Year of date. Must be from 1 to 9999.
  toDate_day: integer, Day of month. Must be from 1 to 31 and valid for the year and month.
  toDate_month: integer, Month of date. Must be from 1 to 12.
  toDate_year: integer, Year of date. Must be from 1 to 9999.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  "averageIndexedItemCount": "A String", # Average item count for the given date range for which billing is done.
  "stats": [ # Summary of indexed item counts, one for each day in the requested range.
    { # Aggregation of items by status code as of the specified date.
      "date": { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date between the year 1 and 9999. # 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.
        "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
        "month": 42, # Month of date. Must be from 1 to 12.
        "year": 42, # Year of date. Must be from 1 to 9999.
      },
      "itemCountByStatus": [ # Number of items aggregrated by status code.
        {
          "count": "A String", # Number of items matching the status code.
          "indexedItemsCount": "A String", # 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.
          "statusCode": "A String", # Status of the items.
        },
      ],
    },
  ],
}