View Source GoogleApi.CloudSearch.V1.Api.Stats (google_api_cloud_search v0.24.0)

API calls for all endpoints tagged Stats.

Summary

Functions

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.

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

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

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.

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

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

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

Get the # of search sessions, % of successful sessions with a click query statistics for search application. Note: This API requires a standard end user account to execute.

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

Functions

Link to this function

cloudsearch_stats_get_index(connection, optional_params \\ [], opts \\ [])

View Source
@spec cloudsearch_stats_get_index(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.CloudSearch.V1.Model.GetCustomerIndexStatsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.CloudSearch.V1.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :"fromDate.day" (type: integer()) - Day of month. Must be from 1 to 31 and valid for the year and month.
    • :"fromDate.month" (type: integer()) - Month of date. Must be from 1 to 12.
    • :"fromDate.year" (type: integer()) - Year of date. Must be from 1 to 9999.
    • :"toDate.day" (type: integer()) - Day of month. Must be from 1 to 31 and valid for the year and month.
    • :"toDate.month" (type: integer()) - Month of date. Must be from 1 to 12.
    • :"toDate.year" (type: integer()) - Year of date. Must be from 1 to 9999.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.CloudSearch.V1.Model.GetCustomerIndexStatsResponse{}} on success
  • {:error, info} on failure
Link to this function

cloudsearch_stats_get_query(connection, optional_params \\ [], opts \\ [])

View Source
@spec cloudsearch_stats_get_query(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.CloudSearch.V1.Model.GetCustomerQueryStatsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.CloudSearch.V1.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :"fromDate.day" (type: integer()) - Day of month. Must be from 1 to 31 and valid for the year and month.
    • :"fromDate.month" (type: integer()) - Month of date. Must be from 1 to 12.
    • :"fromDate.year" (type: integer()) - Year of date. Must be from 1 to 9999.
    • :"toDate.day" (type: integer()) - Day of month. Must be from 1 to 31 and valid for the year and month.
    • :"toDate.month" (type: integer()) - Month of date. Must be from 1 to 12.
    • :"toDate.year" (type: integer()) - Year of date. Must be from 1 to 9999.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.CloudSearch.V1.Model.GetCustomerQueryStatsResponse{}} on success
  • {:error, info} on failure
Link to this function

cloudsearch_stats_get_searchapplication(connection, optional_params \\ [], opts \\ [])

View Source
@spec cloudsearch_stats_get_searchapplication(
  Tesla.Env.client(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.CloudSearch.V1.Model.GetCustomerSearchApplicationStatsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.CloudSearch.V1.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :"endDate.day" (type: integer()) - Day of month. Must be from 1 to 31 and valid for the year and month.
    • :"endDate.month" (type: integer()) - Month of date. Must be from 1 to 12.
    • :"endDate.year" (type: integer()) - Year of date. Must be from 1 to 9999.
    • :"startDate.day" (type: integer()) - Day of month. Must be from 1 to 31 and valid for the year and month.
    • :"startDate.month" (type: integer()) - Month of date. Must be from 1 to 12.
    • :"startDate.year" (type: integer()) - Year of date. Must be from 1 to 9999.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.CloudSearch.V1.Model.GetCustomerSearchApplicationStatsResponse{}} on success
  • {:error, info} on failure
Link to this function

cloudsearch_stats_get_session(connection, optional_params \\ [], opts \\ [])

View Source
@spec cloudsearch_stats_get_session(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.CloudSearch.V1.Model.GetCustomerSessionStatsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.CloudSearch.V1.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :"fromDate.day" (type: integer()) - Day of month. Must be from 1 to 31 and valid for the year and month.
    • :"fromDate.month" (type: integer()) - Month of date. Must be from 1 to 12.
    • :"fromDate.year" (type: integer()) - Year of date. Must be from 1 to 9999.
    • :"toDate.day" (type: integer()) - Day of month. Must be from 1 to 31 and valid for the year and month.
    • :"toDate.month" (type: integer()) - Month of date. Must be from 1 to 12.
    • :"toDate.year" (type: integer()) - Year of date. Must be from 1 to 9999.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.CloudSearch.V1.Model.GetCustomerSessionStatsResponse{}} on success
  • {:error, info} on failure
Link to this function

cloudsearch_stats_get_user(connection, optional_params \\ [], opts \\ [])

View Source
@spec cloudsearch_stats_get_user(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.CloudSearch.V1.Model.GetCustomerUserStatsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.CloudSearch.V1.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :"fromDate.day" (type: integer()) - Day of month. Must be from 1 to 31 and valid for the year and month.
    • :"fromDate.month" (type: integer()) - Month of date. Must be from 1 to 12.
    • :"fromDate.year" (type: integer()) - Year of date. Must be from 1 to 9999.
    • :"toDate.day" (type: integer()) - Day of month. Must be from 1 to 31 and valid for the year and month.
    • :"toDate.month" (type: integer()) - Month of date. Must be from 1 to 12.
    • :"toDate.year" (type: integer()) - Year of date. Must be from 1 to 9999.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.CloudSearch.V1.Model.GetCustomerUserStatsResponse{}} on success
  • {:error, info} on failure
Link to this function

cloudsearch_stats_index_datasources_get(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec cloudsearch_stats_index_datasources_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.CloudSearch.V1.Model.GetDataSourceIndexStatsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.CloudSearch.V1.Connection.t) - Connection to server
  • name (type: String.t) - The resource id of the data source to retrieve statistics for, in the following format: "datasources/{source_id}"
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :"fromDate.day" (type: integer()) - Day of month. Must be from 1 to 31 and valid for the year and month.
    • :"fromDate.month" (type: integer()) - Month of date. Must be from 1 to 12.
    • :"fromDate.year" (type: integer()) - Year of date. Must be from 1 to 9999.
    • :"toDate.day" (type: integer()) - Day of month. Must be from 1 to 31 and valid for the year and month.
    • :"toDate.month" (type: integer()) - Month of date. Must be from 1 to 12.
    • :"toDate.year" (type: integer()) - Year of date. Must be from 1 to 9999.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.CloudSearch.V1.Model.GetDataSourceIndexStatsResponse{}} on success
  • {:error, info} on failure
Link to this function

cloudsearch_stats_query_searchapplications_get(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec cloudsearch_stats_query_searchapplications_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.CloudSearch.V1.Model.GetSearchApplicationQueryStatsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.CloudSearch.V1.Connection.t) - Connection to server
  • name (type: String.t) - The resource id of the search application query stats, in the following format: searchapplications/{application_id}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :"fromDate.day" (type: integer()) - Day of month. Must be from 1 to 31 and valid for the year and month.
    • :"fromDate.month" (type: integer()) - Month of date. Must be from 1 to 12.
    • :"fromDate.year" (type: integer()) - Year of date. Must be from 1 to 9999.
    • :"toDate.day" (type: integer()) - Day of month. Must be from 1 to 31 and valid for the year and month.
    • :"toDate.month" (type: integer()) - Month of date. Must be from 1 to 12.
    • :"toDate.year" (type: integer()) - Year of date. Must be from 1 to 9999.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.CloudSearch.V1.Model.GetSearchApplicationQueryStatsResponse{}} on success
  • {:error, info} on failure
Link to this function

cloudsearch_stats_session_searchapplications_get(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec cloudsearch_stats_session_searchapplications_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.CloudSearch.V1.Model.GetSearchApplicationSessionStatsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Get the # of search sessions, % of successful sessions with a click query statistics for search application. Note: This API requires a standard end user account to execute.

Parameters

  • connection (type: GoogleApi.CloudSearch.V1.Connection.t) - Connection to server
  • name (type: String.t) - The resource id of the search application session stats, in the following format: searchapplications/{application_id}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :"fromDate.day" (type: integer()) - Day of month. Must be from 1 to 31 and valid for the year and month.
    • :"fromDate.month" (type: integer()) - Month of date. Must be from 1 to 12.
    • :"fromDate.year" (type: integer()) - Year of date. Must be from 1 to 9999.
    • :"toDate.day" (type: integer()) - Day of month. Must be from 1 to 31 and valid for the year and month.
    • :"toDate.month" (type: integer()) - Month of date. Must be from 1 to 12.
    • :"toDate.year" (type: integer()) - Year of date. Must be from 1 to 9999.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.CloudSearch.V1.Model.GetSearchApplicationSessionStatsResponse{}} on success
  • {:error, info} on failure
Link to this function

cloudsearch_stats_user_searchapplications_get(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec cloudsearch_stats_user_searchapplications_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.CloudSearch.V1.Model.GetSearchApplicationUserStatsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.CloudSearch.V1.Connection.t) - Connection to server
  • name (type: String.t) - The resource id of the search application session stats, in the following format: searchapplications/{application_id}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :"fromDate.day" (type: integer()) - Day of month. Must be from 1 to 31 and valid for the year and month.
    • :"fromDate.month" (type: integer()) - Month of date. Must be from 1 to 12.
    • :"fromDate.year" (type: integer()) - Year of date. Must be from 1 to 9999.
    • :"toDate.day" (type: integer()) - Day of month. Must be from 1 to 31 and valid for the year and month.
    • :"toDate.month" (type: integer()) - Month of date. Must be from 1 to 12.
    • :"toDate.year" (type: integer()) - Year of date. Must be from 1 to 9999.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.CloudSearch.V1.Model.GetSearchApplicationUserStatsResponse{}} on success
  • {:error, info} on failure