Cloud Search API . stats

Instance Methods

index()

Returns the index Resource.

query()

Returns the query Resource.

session()

Returns the session Resource.

user()

Returns the user Resource.

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

Gets indexed item statistics aggreggated across all data sources. This

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

Get the query statistics for customer.

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

Get the # of search sessions, % of successful sessions with a click query

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

Get the users statistics for customer.

Method Details

getIndex(toDate_year=None, fromDate_month=None, fromDate_year=None, toDate_month=None, x__xgafv=None, toDate_day=None, fromDate_day=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:
  toDate_year: integer, Year of date. Must be from 1 to 9999.
  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_month: integer, Month of date. Must be from 1 to 12.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format
  toDate_day: integer, Day of month. Must be from 1 to 31 and valid for the year and month.
  fromDate_day: integer, Day of month. Must be from 1 to 31 and valid for the year and month.

Returns:
  An object of the form:

    {
    "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 statistics were calculated.
          "year": 42, # Year of date. Must be from 1 to 9999.
          "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.
        },
        "itemCountByStatus": [ # Number of items aggregrated by status code.
          {
            "count": "A String", # Number of items matching the status code.
            "statusCode": "A String", # Status of the items.
          },
        ],
      },
    ],
  }
getQuery(toDate_year=None, fromDate_month=None, fromDate_year=None, toDate_month=None, x__xgafv=None, toDate_day=None, fromDate_day=None)
Get the query statistics for customer.

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

Args:
  toDate_year: integer, Year of date. Must be from 1 to 9999.
  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_month: integer, Month of date. Must be from 1 to 12.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format
  toDate_day: integer, Day of month. Must be from 1 to 31 and valid for the year and month.
  fromDate_day: integer, Day of month. Must be from 1 to 31 and valid for the year and month.

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. # Date for which query stats were calculated. Stats calculated on the next
            # day close to midnight are returned.
          "year": 42, # Year of date. Must be from 1 to 9999.
          "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.
        },
        "queryCountByStatus": [
          {
            "count": "A String",
            "statusCode": 42, # This represents the http status code.
          },
        ],
      },
    ],
  }
getSession(toDate_year=None, fromDate_month=None, fromDate_year=None, toDate_month=None, x__xgafv=None, toDate_day=None, fromDate_day=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:
  toDate_year: integer, Year of date. Must be from 1 to 9999.
  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_month: integer, Month of date. Must be from 1 to 12.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format
  toDate_day: integer, Day of month. Must be from 1 to 31 and valid for the year and month.
  fromDate_day: integer, Day of month. Must be from 1 to 31 and valid for the year and month.

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. # Date for which session stats were calculated. Stats calculated on the next
            # day close to midnight are returned.
          "year": 42, # Year of date. Must be from 1 to 9999.
          "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.
        },
        "searchSessionsCount": "A String", # The count of search sessions on the day
      },
    ],
  }
getUser(toDate_year=None, fromDate_month=None, fromDate_year=None, toDate_month=None, x__xgafv=None, toDate_day=None, fromDate_day=None)
Get the users statistics for customer.

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

Args:
  toDate_year: integer, Year of date. Must be from 1 to 9999.
  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_month: integer, Month of date. Must be from 1 to 12.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format
  toDate_day: integer, Day of month. Must be from 1 to 31 and valid for the year and month.
  fromDate_day: integer, Day of month. Must be from 1 to 31 and valid for the year and month.

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. # Date for which session stats were calculated. Stats calculated on the next
            # day close to midnight are returned.
          "year": 42, # Year of date. Must be from 1 to 9999.
          "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.
        },
        "sevenDaysActiveUsersCount": "A String", # The count of unique active users in the past seven days
        "oneDayActiveUsersCount": "A String", # The count of unique active users in the past one day
        "thirtyDaysActiveUsersCount": "A String", # The count of unique active users in the past thirty days
      },
    ],
  }