Cloud Search API . stats

close()

Close httplib2 connections.

getIndex(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 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.

Args:
  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. # The date for which statistics were calculated.
        "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.
        },
      ],
    },
  ],
}

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

Get the query statistics for customer. **Note:** This API requires a standard end user account to execute.

Args:
  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:

    {
  "stats": [
    {
      "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. # The date for which query stats were calculated. Stats calculated on the next day close to midnight 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.
      },
      "queryCountByStatus": [
        {
          "count": "A String",
          "statusCode": 42, # This represents the http status code.
        },
      ],
    },
  ],
  "totalQueryCount": "A String", # Total successful query count (status code 200) for the given date range.
}

getSearchapplication(endDate_day=None, endDate_month=None, endDate_year=None, startDate_day=None, startDate_month=None, startDate_year=None, x__xgafv=None)

Get search application stats for customer. **Note:** This API requires a standard end user account to execute.

Args:
  endDate_day: integer, Day of month. Must be from 1 to 31 and valid for the year and month.
  endDate_month: integer, Month of date. Must be from 1 to 12.
  endDate_year: integer, Year of date. Must be from 1 to 9999.
  startDate_day: integer, Day of month. Must be from 1 to 31 and valid for the year and month.
  startDate_month: integer, Month of date. Must be from 1 to 12.
  startDate_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:

    { # Response format for search application stats for a customer.
  "averageSearchApplicationCount": "A String", # Average search application count for the given date range.
  "stats": [ # Search application stats by date.
    { # Search application stats for a customer for the given date.
      "count": "A String", # The count of search applications for the 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. # The date for which search application stats were calculated.
        "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.
      },
    },
  ],
}

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

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.

Args:
  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:

    {
  "stats": [
    {
      "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. # The date for which session stats were calculated. Stats are calculated on the following day, close to midnight PST, and then 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.
      },
      "searchSessionsCount": "A String", # The count of search sessions on the day
    },
  ],
}

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

Get the users statistics for customer. **Note:** This API requires a standard end user account to execute.

Args:
  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:

    {
  "stats": [
    {
      "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. # The date for which session stats were calculated. Stats calculated on the next day close to midnight 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.
      },
      "oneDayActiveUsersCount": "A String", # The count of unique active users in the past one day
      "sevenDaysActiveUsersCount": "A String", # The count of unique active users in the past seven days
      "thirtyDaysActiveUsersCount": "A String", # The count of unique active users in the past thirty days
    },
  ],
}