RubyDoc.info: Class: Algolia::AnalyticsClient – Documentation for algolia (3.45.0)

#add_user_agent_segment(segment, version = nil) ⇒ `Object`

# File 'lib/algolia/api/analytics_client.rb', line 67

def add_user_agent_segment(segment, version = nil)
  @api_client.config.add_user_agent_segment(segment, version)

  self
end

#custom_delete(path, parameters = nil, request_options = {}) ⇒ `Object`

Parameters:

path (String) —
Path of the endpoint, for example 1/newFeature. (required)
parameters (Hash<String, Object>) (defaults to: nil) —
Query parameters to apply to the current query.
request_options: —
The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

(Object)

# File 'lib/algolia/api/analytics_client.rb', line 115

def custom_delete(path, parameters = nil, request_options = {})
  response = custom_delete_with_http_info(path, parameters, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Object")
end

#custom_delete_with_http_info(path, parameters = nil, request_options = {}) ⇒ `Http::Response`

Returns the response.

Parameters:

path (String) —
Path of the endpoint, for example 1/newFeature. (required)
parameters (Hash<String, Object>) (defaults to: nil) —
Query parameters to apply to the current query.
request_options: —
The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

(Http::Response) —
the response

# File 'lib/algolia/api/analytics_client.rb', line 79

def custom_delete_with_http_info(path, parameters = nil, request_options = {})
  # verify the required parameter 'path' is set
  if @api_client.config.client_side_validation && path.nil?
    raise ArgumentError, "Parameter `path` is required when calling `custom_delete`."
  end
  # verify the required parameter 'path' is not empty
  if @api_client.config.client_side_validation && path.empty?
    raise ArgumentError, "Parameter `path` is required when calling `custom_delete`."
  end

  path = "/{path}".sub("{" + "path" + "}", path.to_s)
  query_params = {}
  query_params = query_params.merge(parameters) unless parameters.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"AnalyticsClient.custom_delete",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:DELETE, path, new_options)
end

#custom_get(path, parameters = nil, request_options = {}) ⇒ `Object`

Parameters:

path (String) —
Path of the endpoint, for example 1/newFeature. (required)
parameters (Hash<String, Object>) (defaults to: nil) —
Query parameters to apply to the current query.
request_options: —
The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

(Object)

# File 'lib/algolia/api/analytics_client.rb', line 162

def custom_get(path, parameters = nil, request_options = {})
  response = custom_get_with_http_info(path, parameters, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Object")
end

#custom_get_with_http_info(path, parameters = nil, request_options = {}) ⇒ `Http::Response`

Returns the response.

Parameters:

path (String) —
Path of the endpoint, for example 1/newFeature. (required)
parameters (Hash<String, Object>) (defaults to: nil) —
Query parameters to apply to the current query.
request_options: —
The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

(Http::Response) —
the response

# File 'lib/algolia/api/analytics_client.rb', line 126

def custom_get_with_http_info(path, parameters = nil, request_options = {})
  # verify the required parameter 'path' is set
  if @api_client.config.client_side_validation && path.nil?
    raise ArgumentError, "Parameter `path` is required when calling `custom_get`."
  end
  # verify the required parameter 'path' is not empty
  if @api_client.config.client_side_validation && path.empty?
    raise ArgumentError, "Parameter `path` is required when calling `custom_get`."
  end

  path = "/{path}".sub("{" + "path" + "}", path.to_s)
  query_params = {}
  query_params = query_params.merge(parameters) unless parameters.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"AnalyticsClient.custom_get",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#custom_post(path, parameters = nil, body = nil, request_options = {}) ⇒ `Object`

Parameters:

path (String) —
Path of the endpoint, for example 1/newFeature. (required)
parameters (Hash<String, Object>) (defaults to: nil) —
Query parameters to apply to the current query.
body (Object) (defaults to: nil) —
Parameters to send with the custom request.
request_options: —
The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

(Object)

# File 'lib/algolia/api/analytics_client.rb', line 211

def custom_post(path, parameters = nil, body = nil, request_options = {})
  response = custom_post_with_http_info(path, parameters, body, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Object")
end

#custom_post_with_http_info(path, parameters = nil, body = nil, request_options = {}) ⇒ `Http::Response`

Returns the response.

Parameters:

path (String) —
Path of the endpoint, for example 1/newFeature. (required)
parameters (Hash<String, Object>) (defaults to: nil) —
Query parameters to apply to the current query.
body (Object) (defaults to: nil) —
Parameters to send with the custom request.
request_options: —
The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

(Http::Response) —
the response

# File 'lib/algolia/api/analytics_client.rb', line 174

def custom_post_with_http_info(path, parameters = nil, body = nil, request_options = {})
  # verify the required parameter 'path' is set
  if @api_client.config.client_side_validation && path.nil?
    raise ArgumentError, "Parameter `path` is required when calling `custom_post`."
  end
  # verify the required parameter 'path' is not empty
  if @api_client.config.client_side_validation && path.empty?
    raise ArgumentError, "Parameter `path` is required when calling `custom_post`."
  end

  path = "/{path}".sub("{" + "path" + "}", path.to_s)
  query_params = {}
  query_params = query_params.merge(parameters) unless parameters.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body] || @api_client.object_to_http_body(body)

  new_options = request_options.merge(
    :operation => :"AnalyticsClient.custom_post",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:POST, path, new_options)
end

#custom_put(path, parameters = nil, body = nil, request_options = {}) ⇒ `Object`

Parameters:

path (String) —
Path of the endpoint, for example 1/newFeature. (required)
parameters (Hash<String, Object>) (defaults to: nil) —
Query parameters to apply to the current query.
body (Object) (defaults to: nil) —
Parameters to send with the custom request.
request_options: —
The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

(Object)

# File 'lib/algolia/api/analytics_client.rb', line 260

def custom_put(path, parameters = nil, body = nil, request_options = {})
  response = custom_put_with_http_info(path, parameters, body, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Object")
end

#custom_put_with_http_info(path, parameters = nil, body = nil, request_options = {}) ⇒ `Http::Response`

Returns the response.

Parameters:

path (String) —
Path of the endpoint, for example 1/newFeature. (required)
parameters (Hash<String, Object>) (defaults to: nil) —
Query parameters to apply to the current query.
body (Object) (defaults to: nil) —
Parameters to send with the custom request.
request_options: —
The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

(Http::Response) —
the response

# File 'lib/algolia/api/analytics_client.rb', line 223

def custom_put_with_http_info(path, parameters = nil, body = nil, request_options = {})
  # verify the required parameter 'path' is set
  if @api_client.config.client_side_validation && path.nil?
    raise ArgumentError, "Parameter `path` is required when calling `custom_put`."
  end
  # verify the required parameter 'path' is not empty
  if @api_client.config.client_side_validation && path.empty?
    raise ArgumentError, "Parameter `path` is required when calling `custom_put`."
  end

  path = "/{path}".sub("{" + "path" + "}", path.to_s)
  query_params = {}
  query_params = query_params.merge(parameters) unless parameters.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body] || @api_client.object_to_http_body(body)

  new_options = request_options.merge(
    :operation => :"AnalyticsClient.custom_put",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:PUT, path, new_options)
end

#get_add_to_cart_rate(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ `GetAddToCartRateResponse`

Retrieves the add-to-cart rate for all your searches with at least one add-to-cart event, including a daily breakdown. By default, the analyzed period includes the last eight days including the current day. The rate is the number of add-to-cart conversion events divided by the number of tracked searches. A search is tracked if it returns a queryID (clickAnalytics is true). This differs from the response's count, which shows the overall number of searches, including those where clickAnalytics is false. There's a difference between a 0 and null add-to-cart rate when clickAnalytics is enabled: - Null means there were no queries: since Algolia didn't receive any events, the add-to-cart rate is null. - 0 mean there were queries but no add-to-cart events were received.

Required API Key ACLs:

- analytics

Parameters:

index (String) —
Index name. (required)
start_date (String) (defaults to: nil) —
Start date of the period to analyze, in YYYY-MM-DD format.
end_date (String) (defaults to: nil) —
End date of the period to analyze, in YYYY-MM-DD format.
tags (String) (defaults to: nil) —
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Segment your analytics data.
request_options: —
The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

(GetAddToCartRateResponse)

# File 'lib/algolia/api/analytics_client.rb', line 318

def get_add_to_cart_rate(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
  response = get_add_to_cart_rate_with_http_info(index, start_date, end_date, tags, request_options)
  @api_client.deserialize(
    response.body,
    request_options[:debug_return_type] || "Analytics::GetAddToCartRateResponse"
  )
end

#get_add_to_cart_rate_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ `Http::Response`

Retrieves the add-to-cart rate for all your searches with at least one add-to-cart event, including a daily breakdown. By default, the analyzed period includes the last eight days including the current day. The rate is the number of add-to-cart conversion events divided by the number of tracked searches. A search is tracked if it returns a queryID (clickAnalytics is true). This differs from the response's count, which shows the overall number of searches, including those where clickAnalytics is false. There's a difference between a 0 and null add-to-cart rate when clickAnalytics is enabled: - Null means there were no queries: since Algolia didn't receive any events, the add-to-cart rate is null. - 0 mean there were queries but no add-to-cart events were received.

Required API Key ACLs:

- analytics

Parameters:

index (String) —
Index name. (required)
start_date (String) (defaults to: nil) —
Start date of the period to analyze, in YYYY-MM-DD format.
end_date (String) (defaults to: nil) —
End date of the period to analyze, in YYYY-MM-DD format.
tags (String) (defaults to: nil) —
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Segment your analytics data.
request_options: —
The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

(Http::Response) —
the response

# File 'lib/algolia/api/analytics_client.rb', line 275

def get_add_to_cart_rate_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    raise ArgumentError, "Parameter `index` is required when calling `get_add_to_cart_rate`."
  end
  # verify the required parameter 'index' is not empty
  if @api_client.config.client_side_validation && index.empty?
    raise ArgumentError, "Parameter `index` is required when calling `get_add_to_cart_rate`."
  end

  path = "/2/conversions/addToCartRate"
  query_params = {}
  query_params[:index] = index
  query_params[:startDate] = start_date unless start_date.nil?
  query_params[:endDate] = end_date unless end_date.nil?
  query_params[:tags] = tags unless tags.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"AnalyticsClient.get_add_to_cart_rate",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#get_average_click_position(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ `GetAverageClickPositionResponse`

Retrieves the average click position of your search results, including a daily breakdown. The average click position is the average of all clicked search result positions. For example, if users only ever click on the first result for any search, the average click position is 1. By default, the analyzed period includes the last eight days including the current day. An average of null when clickAnalytics is enabled means Algolia didn't receive any click events for the queries. The average is null until Algolia receives at least one click event.

Required API Key ACLs:

- analytics

Parameters:

index (String) —
Index name. (required)
start_date (String) (defaults to: nil) —
Start date of the period to analyze, in YYYY-MM-DD format.
end_date (String) (defaults to: nil) —
End date of the period to analyze, in YYYY-MM-DD format.
tags (String) (defaults to: nil) —
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Segment your analytics data.
request_options: —
The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

(GetAverageClickPositionResponse)

# File 'lib/algolia/api/analytics_client.rb', line 385

def get_average_click_position(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
  response = get_average_click_position_with_http_info(index, start_date, end_date, tags, request_options)
  @api_client.deserialize(
    response.body,
    request_options[:debug_return_type] || "Analytics::GetAverageClickPositionResponse"
  )
end

#get_average_click_position_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ `Http::Response`

Retrieves the average click position of your search results, including a daily breakdown. The average click position is the average of all clicked search result positions. For example, if users only ever click on the first result for any search, the average click position is 1. By default, the analyzed period includes the last eight days including the current day. An average of null when clickAnalytics is enabled means Algolia didn't receive any click events for the queries. The average is null until Algolia receives at least one click event.

Required API Key ACLs:

- analytics

Parameters:

index (String) —
Index name. (required)
start_date (String) (defaults to: nil) —
Start date of the period to analyze, in YYYY-MM-DD format.
end_date (String) (defaults to: nil) —
End date of the period to analyze, in YYYY-MM-DD format.
tags (String) (defaults to: nil) —
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Segment your analytics data.
request_options: —
The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

(Http::Response) —
the response

# File 'lib/algolia/api/analytics_client.rb', line 336

def get_average_click_position_with_http_info(
  index,
  start_date = nil,
  end_date = nil,
  tags = nil,
  request_options = {}
)
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    raise ArgumentError, "Parameter `index` is required when calling `get_average_click_position`."
  end
  # verify the required parameter 'index' is not empty
  if @api_client.config.client_side_validation && index.empty?
    raise ArgumentError, "Parameter `index` is required when calling `get_average_click_position`."
  end

  path = "/2/clicks/averageClickPosition"
  query_params = {}
  query_params[:index] = index
  query_params[:startDate] = start_date unless start_date.nil?
  query_params[:endDate] = end_date unless end_date.nil?
  query_params[:tags] = tags unless tags.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"AnalyticsClient.get_average_click_position",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#get_click_positions(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ `GetClickPositionsResponse`

Retrieves the positions in the search results and their associated number of clicks. This lets you check how many clicks the first, second, or tenth search results receive. An average of 0 when clickAnalytics is enabled means Algolia didn't receive any click events for the queries.

Required API Key ACLs:

- analytics

Parameters:

index (String) —
Index name. (required)
start_date (String) (defaults to: nil) —
Start date of the period to analyze, in YYYY-MM-DD format.
end_date (String) (defaults to: nil) —
End date of the period to analyze, in YYYY-MM-DD format.
tags (String) (defaults to: nil) —
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Segment your analytics data.
request_options: —
The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

(GetClickPositionsResponse)

# File 'lib/algolia/api/analytics_client.rb', line 446

def get_click_positions(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
  response = get_click_positions_with_http_info(index, start_date, end_date, tags, request_options)
  @api_client.deserialize(
    response.body,
    request_options[:debug_return_type] || "Analytics::GetClickPositionsResponse"
  )
end

#get_click_positions_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ `Http::Response`

Retrieves the positions in the search results and their associated number of clicks. This lets you check how many clicks the first, second, or tenth search results receive. An average of 0 when clickAnalytics is enabled means Algolia didn't receive any click events for the queries.

Required API Key ACLs:

- analytics

Parameters:

index (String) —
Index name. (required)
start_date (String) (defaults to: nil) —
Start date of the period to analyze, in YYYY-MM-DD format.
end_date (String) (defaults to: nil) —
End date of the period to analyze, in YYYY-MM-DD format.
tags (String) (defaults to: nil) —
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Segment your analytics data.
request_options: —
The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

(Http::Response) —
the response

# File 'lib/algolia/api/analytics_client.rb', line 403

def get_click_positions_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    raise ArgumentError, "Parameter `index` is required when calling `get_click_positions`."
  end
  # verify the required parameter 'index' is not empty
  if @api_client.config.client_side_validation && index.empty?
    raise ArgumentError, "Parameter `index` is required when calling `get_click_positions`."
  end

  path = "/2/clicks/positions"
  query_params = {}
  query_params[:index] = index
  query_params[:startDate] = start_date unless start_date.nil?
  query_params[:endDate] = end_date unless end_date.nil?
  query_params[:tags] = tags unless tags.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"AnalyticsClient.get_click_positions",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#get_click_through_rate(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ `GetClickThroughRateResponse`

Retrieves the click-through rate (CTR) for all your searches with at least one click event, including a daily breakdown. By default, the analyzed period includes the last eight days including the current day. There's a difference between a 0 and null CTR when clickAnalytics is enabled: - Null means there were no queries: since Algolia didn't receive any events, CTR is null. - 0 mean there were queries but no click events were received.

Required API Key ACLs:

- analytics

Parameters:

index (String) —
Index name. (required)
start_date (String) (defaults to: nil) —
Start date of the period to analyze, in YYYY-MM-DD format.
end_date (String) (defaults to: nil) —
End date of the period to analyze, in YYYY-MM-DD format.
tags (String) (defaults to: nil) —
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Segment your analytics data.
request_options: —
The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

(GetClickThroughRateResponse)

# File 'lib/algolia/api/analytics_client.rb', line 507

def get_click_through_rate(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
  response = get_click_through_rate_with_http_info(index, start_date, end_date, tags, request_options)
  @api_client.deserialize(
    response.body,
    request_options[:debug_return_type] || "Analytics::GetClickThroughRateResponse"
  )
end

#get_click_through_rate_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ `Http::Response`

Retrieves the click-through rate (CTR) for all your searches with at least one click event, including a daily breakdown. By default, the analyzed period includes the last eight days including the current day. There's a difference between a 0 and null CTR when clickAnalytics is enabled: - Null means there were no queries: since Algolia didn't receive any events, CTR is null. - 0 mean there were queries but no click events were received.

Required API Key ACLs:

- analytics

Parameters:

index (String) —
Index name. (required)
start_date (String) (defaults to: nil) —
Start date of the period to analyze, in YYYY-MM-DD format.
end_date (String) (defaults to: nil) —
End date of the period to analyze, in YYYY-MM-DD format.
tags (String) (defaults to: nil) —
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Segment your analytics data.
request_options: —
The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

(Http::Response) —
the response

# File 'lib/algolia/api/analytics_client.rb', line 464

def get_click_through_rate_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    raise ArgumentError, "Parameter `index` is required when calling `get_click_through_rate`."
  end
  # verify the required parameter 'index' is not empty
  if @api_client.config.client_side_validation && index.empty?
    raise ArgumentError, "Parameter `index` is required when calling `get_click_through_rate`."
  end

  path = "/2/clicks/clickThroughRate"
  query_params = {}
  query_params[:index] = index
  query_params[:startDate] = start_date unless start_date.nil?
  query_params[:endDate] = end_date unless end_date.nil?
  query_params[:tags] = tags unless tags.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"AnalyticsClient.get_click_through_rate",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#get_conversion_rate(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ `GetConversionRateResponse`

Retrieves the conversion rate (CR) for all your searches with at least one conversion event, including a daily breakdown. By default, the analyzed period includes the last eight days including the current day. There's a difference between a 0 and null CR when clickAnalytics is enabled: - Null means there were no queries: since Algolia didn't receive any events, CR is null. - 0 mean there were queries but no conversion events were received.

Required API Key ACLs:

- analytics

Parameters:

index (String) —
Index name. (required)
start_date (String) (defaults to: nil) —
Start date of the period to analyze, in YYYY-MM-DD format.
end_date (String) (defaults to: nil) —
End date of the period to analyze, in YYYY-MM-DD format.
tags (String) (defaults to: nil) —
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Segment your analytics data.
request_options: —
The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

(GetConversionRateResponse)

# File 'lib/algolia/api/analytics_client.rb', line 568

def get_conversion_rate(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
  response = get_conversion_rate_with_http_info(index, start_date, end_date, tags, request_options)
  @api_client.deserialize(
    response.body,
    request_options[:debug_return_type] || "Analytics::GetConversionRateResponse"
  )
end

#get_conversion_rate_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ `Http::Response`

Retrieves the conversion rate (CR) for all your searches with at least one conversion event, including a daily breakdown. By default, the analyzed period includes the last eight days including the current day. There's a difference between a 0 and null CR when clickAnalytics is enabled: - Null means there were no queries: since Algolia didn't receive any events, CR is null. - 0 mean there were queries but no conversion events were received.

Required API Key ACLs:

- analytics

Parameters:

index (String) —
Index name. (required)
start_date (String) (defaults to: nil) —
Start date of the period to analyze, in YYYY-MM-DD format.
end_date (String) (defaults to: nil) —
End date of the period to analyze, in YYYY-MM-DD format.
tags (String) (defaults to: nil) —
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Segment your analytics data.
request_options: —
The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

(Http::Response) —
the response

# File 'lib/algolia/api/analytics_client.rb', line 525

def get_conversion_rate_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    raise ArgumentError, "Parameter `index` is required when calling `get_conversion_rate`."
  end
  # verify the required parameter 'index' is not empty
  if @api_client.config.client_side_validation && index.empty?
    raise ArgumentError, "Parameter `index` is required when calling `get_conversion_rate`."
  end

  path = "/2/conversions/conversionRate"
  query_params = {}
  query_params[:index] = index
  query_params[:startDate] = start_date unless start_date.nil?
  query_params[:endDate] = end_date unless end_date.nil?
  query_params[:tags] = tags unless tags.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"AnalyticsClient.get_conversion_rate",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#get_no_click_rate(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ `GetNoClickRateResponse`

Retrieves the fraction of searches that didn't lead to any click within a time range, including a daily breakdown. It also returns the number of tracked searches and tracked searches without clicks. By default, the analyzed period includes the last eight days including the current day.

Required API Key ACLs:

- analytics

Parameters:

index (String) —
Index name. (required)
start_date (String) (defaults to: nil) —
Start date of the period to analyze, in YYYY-MM-DD format.
end_date (String) (defaults to: nil) —
End date of the period to analyze, in YYYY-MM-DD format.
tags (String) (defaults to: nil) —
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Segment your analytics data.
request_options: —
The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

(GetNoClickRateResponse)

# File 'lib/algolia/api/analytics_client.rb', line 629

def get_no_click_rate(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
  response = get_no_click_rate_with_http_info(index, start_date, end_date, tags, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Analytics::GetNoClickRateResponse")
end

#get_no_click_rate_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ `Http::Response`

Retrieves the fraction of searches that didn't lead to any click within a time range, including a daily breakdown. It also returns the number of tracked searches and tracked searches without clicks. By default, the analyzed period includes the last eight days including the current day.

Required API Key ACLs:

- analytics

Parameters:

index (String) —
Index name. (required)
start_date (String) (defaults to: nil) —
Start date of the period to analyze, in YYYY-MM-DD format.
end_date (String) (defaults to: nil) —
End date of the period to analyze, in YYYY-MM-DD format.
tags (String) (defaults to: nil) —
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Segment your analytics data.
request_options: —
The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

(Http::Response) —
the response

# File 'lib/algolia/api/analytics_client.rb', line 586

def get_no_click_rate_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    raise ArgumentError, "Parameter `index` is required when calling `get_no_click_rate`."
  end
  # verify the required parameter 'index' is not empty
  if @api_client.config.client_side_validation && index.empty?
    raise ArgumentError, "Parameter `index` is required when calling `get_no_click_rate`."
  end

  path = "/2/searches/noClickRate"
  query_params = {}
  query_params[:index] = index
  query_params[:startDate] = start_date unless start_date.nil?
  query_params[:endDate] = end_date unless end_date.nil?
  query_params[:tags] = tags unless tags.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"AnalyticsClient.get_no_click_rate",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#get_no_results_rate(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ `GetNoResultsRateResponse`

Retrieves the fraction of searches that didn't return any results within a time range, including a daily breakdown. It also returns the count of searches and searches without results used to compute the rates. By default, the analyzed period includes the last eight days including the current day.

Required API Key ACLs:

- analytics

Parameters:

index (String) —
Index name. (required)
start_date (String) (defaults to: nil) —
Start date of the period to analyze, in YYYY-MM-DD format.
end_date (String) (defaults to: nil) —
End date of the period to analyze, in YYYY-MM-DD format.
tags (String) (defaults to: nil) —
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Segment your analytics data.
request_options: —
The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

(GetNoResultsRateResponse)

# File 'lib/algolia/api/analytics_client.rb', line 687

def get_no_results_rate(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
  response = get_no_results_rate_with_http_info(index, start_date, end_date, tags, request_options)
  @api_client.deserialize(
    response.body,
    request_options[:debug_return_type] || "Analytics::GetNoResultsRateResponse"
  )
end

#get_no_results_rate_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ `Http::Response`

Retrieves the fraction of searches that didn't return any results within a time range, including a daily breakdown. It also returns the count of searches and searches without results used to compute the rates. By default, the analyzed period includes the last eight days including the current day.

Required API Key ACLs:

- analytics

Parameters:

index (String) —
Index name. (required)
start_date (String) (defaults to: nil) —
Start date of the period to analyze, in YYYY-MM-DD format.
end_date (String) (defaults to: nil) —
End date of the period to analyze, in YYYY-MM-DD format.
tags (String) (defaults to: nil) —
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Segment your analytics data.
request_options: —
The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

(Http::Response) —
the response

# File 'lib/algolia/api/analytics_client.rb', line 644

def get_no_results_rate_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    raise ArgumentError, "Parameter `index` is required when calling `get_no_results_rate`."
  end
  # verify the required parameter 'index' is not empty
  if @api_client.config.client_side_validation && index.empty?
    raise ArgumentError, "Parameter `index` is required when calling `get_no_results_rate`."
  end

  path = "/2/searches/noResultRate"
  query_params = {}
  query_params[:index] = index
  query_params[:startDate] = start_date unless start_date.nil?
  query_params[:endDate] = end_date unless end_date.nil?
  query_params[:tags] = tags unless tags.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"AnalyticsClient.get_no_results_rate",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#get_patterns_fields(request_options = {}) ⇒ `Catalog`

Parameters:

request_options: —
The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

(Catalog)

# File 'lib/algolia/api/analytics_client.rb', line 723

def get_patterns_fields(request_options = {})
  response = get_patterns_fields_with_http_info(request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Analytics::Catalog")
end

#get_patterns_fields_with_http_info(request_options = {}) ⇒ `Http::Response`

Returns the response.

Parameters:

request_options: —
The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

(Http::Response) —
the response

# File 'lib/algolia/api/analytics_client.rb', line 699

def get_patterns_fields_with_http_info(request_options = {})
  path = "/3/patterns/fields"
  query_params = {}
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"AnalyticsClient.get_patterns_fields",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#get_purchase_rate(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ `GetPurchaseRateResponse`

Retrieves the purchase rate for all your searches with at least one purchase event, including a daily breakdown. By default, the analyzed period includes the last eight days, including the current day. The rate is purchase conversion events divided by tracked searches. A search is tracked if it returns a query ID (clickAnalytics is true). This differs from the response's count, which includes searches where clickAnalytics is false. There's a difference between a 0 and null purchase rate when clickAnalytics is enabled: - Null means there were no queries. Algolia didn't receive any events, so the purchase rate is null. - 0 means there were queries but no purchase conversion events were received.

Required API Key ACLs:

- analytics

Parameters:

index (String) —
Index name. (required)
start_date (String) (defaults to: nil) —
Start date of the period to analyze, in YYYY-MM-DD format.
end_date (String) (defaults to: nil) —
End date of the period to analyze, in YYYY-MM-DD format.
tags (String) (defaults to: nil) —
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Segment your analytics data.
request_options: —
The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

(GetPurchaseRateResponse)

# File 'lib/algolia/api/analytics_client.rb', line 781

def get_purchase_rate(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
  response = get_purchase_rate_with_http_info(index, start_date, end_date, tags, request_options)
  @api_client.deserialize(
    response.body,
    request_options[:debug_return_type] || "Analytics::GetPurchaseRateResponse"
  )
end

#get_purchase_rate_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ `Http::Response`

Retrieves the purchase rate for all your searches with at least one purchase event, including a daily breakdown. By default, the analyzed period includes the last eight days, including the current day. The rate is purchase conversion events divided by tracked searches. A search is tracked if it returns a query ID (clickAnalytics is true). This differs from the response's count, which includes searches where clickAnalytics is false. There's a difference between a 0 and null purchase rate when clickAnalytics is enabled: - Null means there were no queries. Algolia didn't receive any events, so the purchase rate is null. - 0 means there were queries but no purchase conversion events were received.

Required API Key ACLs:

- analytics

Parameters:

index (String) —
Index name. (required)
start_date (String) (defaults to: nil) —
Start date of the period to analyze, in YYYY-MM-DD format.
end_date (String) (defaults to: nil) —
End date of the period to analyze, in YYYY-MM-DD format.
tags (String) (defaults to: nil) —
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Segment your analytics data.
request_options: —
The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

(Http::Response) —
the response

# File 'lib/algolia/api/analytics_client.rb', line 738

def get_purchase_rate_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    raise ArgumentError, "Parameter `index` is required when calling `get_purchase_rate`."
  end
  # verify the required parameter 'index' is not empty
  if @api_client.config.client_side_validation && index.empty?
    raise ArgumentError, "Parameter `index` is required when calling `get_purchase_rate`."
  end

  path = "/2/conversions/purchaseRate"
  query_params = {}
  query_params[:index] = index
  query_params[:startDate] = start_date unless start_date.nil?
  query_params[:endDate] = end_date unless end_date.nil?
  query_params[:tags] = tags unless tags.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"AnalyticsClient.get_purchase_rate",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#get_revenue(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ `GetRevenue`

Retrieves revenue-related metrics, such as the total revenue or the average order value. To retrieve revenue-related metrics, send purchase events. By default, the analyzed period includes the last eight days including the current day. Revenue is based on purchase conversion events (a conversion event with an eventSubtype attribute of purchase). The revenue is the price attribute multiplied by the quantity attribute for each object in the event's objectData array.

Required API Key ACLs:

- analytics

Parameters:

index (String) —
Index name. (required)
start_date (String) (defaults to: nil) —
Start date of the period to analyze, in YYYY-MM-DD format.
end_date (String) (defaults to: nil) —
End date of the period to analyze, in YYYY-MM-DD format.
tags (String) (defaults to: nil) —
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Segment your analytics data.
request_options: —
The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

(GetRevenue)

# File 'lib/algolia/api/analytics_client.rb', line 842

def get_revenue(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
  response = get_revenue_with_http_info(index, start_date, end_date, tags, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Analytics::GetRevenue")
end

#get_revenue_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ `Http::Response`

Retrieves revenue-related metrics, such as the total revenue or the average order value. To retrieve revenue-related metrics, send purchase events. By default, the analyzed period includes the last eight days including the current day. Revenue is based on purchase conversion events (a conversion event with an eventSubtype attribute of purchase). The revenue is the price attribute multiplied by the quantity attribute for each object in the event's objectData array.

Required API Key ACLs:

- analytics

Parameters:

index (String) —
Index name. (required)
start_date (String) (defaults to: nil) —
Start date of the period to analyze, in YYYY-MM-DD format.
end_date (String) (defaults to: nil) —
End date of the period to analyze, in YYYY-MM-DD format.
tags (String) (defaults to: nil) —
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Segment your analytics data.
request_options: —
The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

(Http::Response) —
the response

# File 'lib/algolia/api/analytics_client.rb', line 799

def get_revenue_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    raise ArgumentError, "Parameter `index` is required when calling `get_revenue`."
  end
  # verify the required parameter 'index' is not empty
  if @api_client.config.client_side_validation && index.empty?
    raise ArgumentError, "Parameter `index` is required when calling `get_revenue`."
  end

  path = "/2/conversions/revenue"
  query_params = {}
  query_params[:index] = index
  query_params[:startDate] = start_date unless start_date.nil?
  query_params[:endDate] = end_date unless end_date.nil?
  query_params[:tags] = tags unless tags.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"AnalyticsClient.get_revenue",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#get_searches_count(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ `GetSearchesCountResponse`

Retrieves the number of searches within a time range, including a daily breakdown. By default, the analyzed period includes the last eight days including the current day.

Required API Key ACLs:

- analytics

Parameters:

index (String) —
Index name. (required)
start_date (String) (defaults to: nil) —
Start date of the period to analyze, in YYYY-MM-DD format.
end_date (String) (defaults to: nil) —
End date of the period to analyze, in YYYY-MM-DD format.
tags (String) (defaults to: nil) —
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Segment your analytics data.
request_options: —
The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

(GetSearchesCountResponse)

# File 'lib/algolia/api/analytics_client.rb', line 900

def get_searches_count(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
  response = get_searches_count_with_http_info(index, start_date, end_date, tags, request_options)
  @api_client.deserialize(
    response.body,
    request_options[:debug_return_type] || "Analytics::GetSearchesCountResponse"
  )
end

#get_searches_count_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ `Http::Response`

Retrieves the number of searches within a time range, including a daily breakdown. By default, the analyzed period includes the last eight days including the current day.

Required API Key ACLs:

- analytics

Parameters:

index (String) —
Index name. (required)
start_date (String) (defaults to: nil) —
Start date of the period to analyze, in YYYY-MM-DD format.
end_date (String) (defaults to: nil) —
End date of the period to analyze, in YYYY-MM-DD format.
tags (String) (defaults to: nil) —
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Segment your analytics data.
request_options: —
The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

(Http::Response) —
the response

# File 'lib/algolia/api/analytics_client.rb', line 857

def get_searches_count_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    raise ArgumentError, "Parameter `index` is required when calling `get_searches_count`."
  end
  # verify the required parameter 'index' is not empty
  if @api_client.config.client_side_validation && index.empty?
    raise ArgumentError, "Parameter `index` is required when calling `get_searches_count`."
  end

  path = "/2/searches/count"
  query_params = {}
  query_params[:index] = index
  query_params[:startDate] = start_date unless start_date.nil?
  query_params[:endDate] = end_date unless end_date.nil?
  query_params[:tags] = tags unless tags.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"AnalyticsClient.get_searches_count",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#get_searches_no_clicks(index, start_date = nil, end_date = nil, limit = nil, offset = nil, tags = nil, request_options = {}) ⇒ `GetSearchesNoClicksResponse`

Retrieves the most popular searches that didn't lead to any clicks, from the 1,000 most frequent searches. For each search, it also returns the number of displayed search results that remained unclicked.

Required API Key ACLs:

- analytics

Parameters:

index (String) —
Index name. (required)
start_date (String) (defaults to: nil) —
Start date of the period to analyze, in YYYY-MM-DD format.
end_date (String) (defaults to: nil) —
End date of the period to analyze, in YYYY-MM-DD format.
limit (Integer) (defaults to: nil) —
Number of items to return. (default to 10)
offset (Integer) (defaults to: nil) —
Position of the first item to return. (default to 0)
tags (String) (defaults to: nil) —
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Segment your analytics data.
request_options: —
The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

(GetSearchesNoClicksResponse)

# File 'lib/algolia/api/analytics_client.rb', line 975

def get_searches_no_clicks(
  index,
  start_date = nil,
  end_date = nil,
  limit = nil,
  offset = nil,
  tags = nil,
  request_options = {}
)
  response = get_searches_no_clicks_with_http_info(
    index,
    start_date,
    end_date,
    limit,
    offset,
    tags,
    request_options
  )
  @api_client.deserialize(
    response.body,
    request_options[:debug_return_type] || "Analytics::GetSearchesNoClicksResponse"
  )
end

#get_searches_no_clicks_with_http_info(index, start_date = nil, end_date = nil, limit = nil, offset = nil, tags = nil, request_options = {}) ⇒ `Http::Response`

Retrieves the most popular searches that didn't lead to any clicks, from the 1,000 most frequent searches. For each search, it also returns the number of displayed search results that remained unclicked.

Required API Key ACLs:

- analytics

Parameters:

index (String) —
Index name. (required)
start_date (String) (defaults to: nil) —
Start date of the period to analyze, in YYYY-MM-DD format.
end_date (String) (defaults to: nil) —
End date of the period to analyze, in YYYY-MM-DD format.
limit (Integer) (defaults to: nil) —
Number of items to return. (default to 10)
offset (Integer) (defaults to: nil) —
Position of the first item to return. (default to 0)
tags (String) (defaults to: nil) —
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Segment your analytics data.
request_options: —
The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

(Http::Response) —
the response

# File 'lib/algolia/api/analytics_client.rb', line 920

def get_searches_no_clicks_with_http_info(
  index,
  start_date = nil,
  end_date = nil,
  limit = nil,
  offset = nil,
  tags = nil,
  request_options = {}
)
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    raise ArgumentError, "Parameter `index` is required when calling `get_searches_no_clicks`."
  end
  # verify the required parameter 'index' is not empty
  if @api_client.config.client_side_validation && index.empty?
    raise ArgumentError, "Parameter `index` is required when calling `get_searches_no_clicks`."
  end

  path = "/2/searches/noClicks"
  query_params = {}
  query_params[:index] = index
  query_params[:startDate] = start_date unless start_date.nil?
  query_params[:endDate] = end_date unless end_date.nil?
  query_params[:limit] = limit unless limit.nil?
  query_params[:offset] = offset unless offset.nil?
  query_params[:tags] = tags unless tags.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"AnalyticsClient.get_searches_no_clicks",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#get_searches_no_results(index, start_date = nil, end_date = nil, limit = nil, offset = nil, tags = nil, request_options = {}) ⇒ `GetSearchesNoResultsResponse`

Retrieves the 1,000 most frequent searches that produced zero results.

Required API Key ACLs:

- analytics

Parameters:

index (String) —
Index name. (required)
start_date (String) (defaults to: nil) —
Start date of the period to analyze, in YYYY-MM-DD format.
end_date (String) (defaults to: nil) —
End date of the period to analyze, in YYYY-MM-DD format.
limit (Integer) (defaults to: nil) —
Number of items to return. (default to 10)
offset (Integer) (defaults to: nil) —
Position of the first item to return. (default to 0)
tags (String) (defaults to: nil) —
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Segment your analytics data.
request_options: —
The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

(GetSearchesNoResultsResponse)

# File 'lib/algolia/api/analytics_client.rb', line 1066

def get_searches_no_results(
  index,
  start_date = nil,
  end_date = nil,
  limit = nil,
  offset = nil,
  tags = nil,
  request_options = {}
)
  response = get_searches_no_results_with_http_info(
    index,
    start_date,
    end_date,
    limit,
    offset,
    tags,
    request_options
  )
  @api_client.deserialize(
    response.body,
    request_options[:debug_return_type] || "Analytics::GetSearchesNoResultsResponse"
  )
end

#get_searches_no_results_with_http_info(index, start_date = nil, end_date = nil, limit = nil, offset = nil, tags = nil, request_options = {}) ⇒ `Http::Response`

Retrieves the 1,000 most frequent searches that produced zero results.

Required API Key ACLs:

- analytics

Parameters:

index (String) —
Index name. (required)
start_date (String) (defaults to: nil) —
Start date of the period to analyze, in YYYY-MM-DD format.
end_date (String) (defaults to: nil) —
End date of the period to analyze, in YYYY-MM-DD format.
limit (Integer) (defaults to: nil) —
Number of items to return. (default to 10)
offset (Integer) (defaults to: nil) —
Position of the first item to return. (default to 0)
tags (String) (defaults to: nil) —
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Segment your analytics data.
request_options: —
The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

(Http::Response) —
the response

# File 'lib/algolia/api/analytics_client.rb', line 1011

def get_searches_no_results_with_http_info(
  index,
  start_date = nil,
  end_date = nil,
  limit = nil,
  offset = nil,
  tags = nil,
  request_options = {}
)
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    raise ArgumentError, "Parameter `index` is required when calling `get_searches_no_results`."
  end
  # verify the required parameter 'index' is not empty
  if @api_client.config.client_side_validation && index.empty?
    raise ArgumentError, "Parameter `index` is required when calling `get_searches_no_results`."
  end

  path = "/2/searches/noResults"
  query_params = {}
  query_params[:index] = index
  query_params[:startDate] = start_date unless start_date.nil?
  query_params[:endDate] = end_date unless end_date.nil?
  query_params[:limit] = limit unless limit.nil?
  query_params[:offset] = offset unless offset.nil?
  query_params[:tags] = tags unless tags.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"AnalyticsClient.get_searches_no_results",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#get_status(index, request_options = {}) ⇒ `GetStatusResponse`

Retrieves the time when the Analytics data for the specified index was last updated. If the index has been recently created or no search has been performed yet the updated time is null. The Analytics data is updated every 5 minutes.

Required API Key ACLs:

- analytics

Parameters:

index (String) —
Index name. (required)
request_options: —
The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

(GetStatusResponse)

# File 'lib/algolia/api/analytics_client.rb', line 1134

def get_status(index, request_options = {})
  response = get_status_with_http_info(index, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Analytics::GetStatusResponse")
end

#get_status_with_http_info(index, request_options = {}) ⇒ `Http::Response`

Retrieves the time when the Analytics data for the specified index was last updated. If the index has been recently created or no search has been performed yet the updated time is null. The Analytics data is updated every 5 minutes.

Required API Key ACLs:

- analytics

Parameters:

index (String) —
Index name. (required)
request_options: —
The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

(Http::Response) —
the response

# File 'lib/algolia/api/analytics_client.rb', line 1097

def get_status_with_http_info(index, request_options = {})
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    raise ArgumentError, "Parameter `index` is required when calling `get_status`."
  end
  # verify the required parameter 'index' is not empty
  if @api_client.config.client_side_validation && index.empty?
    raise ArgumentError, "Parameter `index` is required when calling `get_status`."
  end

  path = "/2/status"
  query_params = {}
  query_params[:index] = index
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"AnalyticsClient.get_status",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#get_top_countries(index, start_date = nil, end_date = nil, limit = nil, offset = nil, tags = nil, request_options = {}) ⇒ `GetTopCountriesResponse`

Retrieves the countries with the most searches in your index.

Required API Key ACLs:

- analytics

Parameters:

index (String) —
Index name. (required)
start_date (String) (defaults to: nil) —
Start date of the period to analyze, in YYYY-MM-DD format.
end_date (String) (defaults to: nil) —
End date of the period to analyze, in YYYY-MM-DD format.
limit (Integer) (defaults to: nil) —
Number of items to return. (default to 10)
offset (Integer) (defaults to: nil) —
Position of the first item to return. (default to 0)
tags (String) (defaults to: nil) —
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Segment your analytics data.
request_options: —
The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

(GetTopCountriesResponse)

# File 'lib/algolia/api/analytics_client.rb', line 1206

def get_top_countries(
  index,
  start_date = nil,
  end_date = nil,
  limit = nil,
  offset = nil,
  tags = nil,
  request_options = {}
)
  response = get_top_countries_with_http_info(index, start_date, end_date, limit, offset, tags, request_options)
  @api_client.deserialize(
    response.body,
    request_options[:debug_return_type] || "Analytics::GetTopCountriesResponse"
  )
end

#get_top_countries_with_http_info(index, start_date = nil, end_date = nil, limit = nil, offset = nil, tags = nil, request_options = {}) ⇒ `Http::Response`

Retrieves the countries with the most searches in your index.

Required API Key ACLs:

- analytics

Parameters:

index (String) —
Index name. (required)
start_date (String) (defaults to: nil) —
Start date of the period to analyze, in YYYY-MM-DD format.
end_date (String) (defaults to: nil) —
End date of the period to analyze, in YYYY-MM-DD format.
limit (Integer) (defaults to: nil) —
Number of items to return. (default to 10)
offset (Integer) (defaults to: nil) —
Position of the first item to return. (default to 0)
tags (String) (defaults to: nil) —
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Segment your analytics data.
request_options: —
The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

(Http::Response) —
the response

# File 'lib/algolia/api/analytics_client.rb', line 1151

def get_top_countries_with_http_info(
  index,
  start_date = nil,
  end_date = nil,
  limit = nil,
  offset = nil,
  tags = nil,
  request_options = {}
)
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    raise ArgumentError, "Parameter `index` is required when calling `get_top_countries`."
  end
  # verify the required parameter 'index' is not empty
  if @api_client.config.client_side_validation && index.empty?
    raise ArgumentError, "Parameter `index` is required when calling `get_top_countries`."
  end

  path = "/2/countries"
  query_params = {}
  query_params[:index] = index
  query_params[:startDate] = start_date unless start_date.nil?
  query_params[:endDate] = end_date unless end_date.nil?
  query_params[:limit] = limit unless limit.nil?
  query_params[:offset] = offset unless offset.nil?
  query_params[:tags] = tags unless tags.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"AnalyticsClient.get_top_countries",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#get_top_filter_attributes(index, search = nil, start_date = nil, end_date = nil, limit = nil, offset = nil, tags = nil, request_options = {}) ⇒ `GetTopFilterAttributesResponse`

Retrieves the 1,000 most frequently used filter attributes. These are attributes of your records that you included in the attributesForFaceting setting.

Required API Key ACLs:

- analytics

Parameters:

index (String) —
Index name. (required)
search (String) (defaults to: nil) —
Search query.
start_date (String) (defaults to: nil) —
Start date of the period to analyze, in YYYY-MM-DD format.
end_date (String) (defaults to: nil) —
End date of the period to analyze, in YYYY-MM-DD format.
limit (Integer) (defaults to: nil) —
Number of items to return. (default to 10)
offset (Integer) (defaults to: nil) —
Position of the first item to return. (default to 0)
tags (String) (defaults to: nil) —
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Segment your analytics data.
request_options: —
The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

(GetTopFilterAttributesResponse)

# File 'lib/algolia/api/analytics_client.rb', line 1293

def get_top_filter_attributes(
  index,
  search = nil,
  start_date = nil,
  end_date = nil,
  limit = nil,
  offset = nil,
  tags = nil,
  request_options = {}
)
  response = get_top_filter_attributes_with_http_info(
    index,
    search,
    start_date,
    end_date,
    limit,
    offset,
    tags,
    request_options
  )
  @api_client.deserialize(
    response.body,
    request_options[:debug_return_type] || "Analytics::GetTopFilterAttributesResponse"
  )
end

#get_top_filter_attributes_with_http_info(index, search = nil, start_date = nil, end_date = nil, limit = nil, offset = nil, tags = nil, request_options = {}) ⇒ `Http::Response`

Retrieves the 1,000 most frequently used filter attributes. These are attributes of your records that you included in the attributesForFaceting setting.

Required API Key ACLs:

- analytics

Parameters:

index (String) —
Index name. (required)
search (String) (defaults to: nil) —
Search query.
start_date (String) (defaults to: nil) —
Start date of the period to analyze, in YYYY-MM-DD format.
end_date (String) (defaults to: nil) —
End date of the period to analyze, in YYYY-MM-DD format.
limit (Integer) (defaults to: nil) —
Number of items to return. (default to 10)
offset (Integer) (defaults to: nil) —
Position of the first item to return. (default to 0)
tags (String) (defaults to: nil) —
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Segment your analytics data.
request_options: —
The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

(Http::Response) —
the response

# File 'lib/algolia/api/analytics_client.rb', line 1235

def get_top_filter_attributes_with_http_info(
  index,
  search = nil,
  start_date = nil,
  end_date = nil,
  limit = nil,
  offset = nil,
  tags = nil,
  request_options = {}
)
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    raise ArgumentError, "Parameter `index` is required when calling `get_top_filter_attributes`."
  end
  # verify the required parameter 'index' is not empty
  if @api_client.config.client_side_validation && index.empty?
    raise ArgumentError, "Parameter `index` is required when calling `get_top_filter_attributes`."
  end

  path = "/2/filters"
  query_params = {}
  query_params[:index] = index
  query_params[:search] = search unless search.nil?
  query_params[:startDate] = start_date unless start_date.nil?
  query_params[:endDate] = end_date unless end_date.nil?
  query_params[:limit] = limit unless limit.nil?
  query_params[:offset] = offset unless offset.nil?
  query_params[:tags] = tags unless tags.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"AnalyticsClient.get_top_filter_attributes",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#get_top_filter_for_attribute(attribute, index, search = nil, start_date = nil, end_date = nil, limit = nil, offset = nil, tags = nil, request_options = {}) ⇒ `GetTopFilterForAttributeResponse`

Retrieves the 1,000 most frequent filter (facet) values for a filter attribute. These are attributes of your records that you included in the attributesForFaceting setting.

Required API Key ACLs:

- analytics

Parameters:

attribute (String) —
Attribute name. (required)
index (String) —
Index name. (required)
search (String) (defaults to: nil) —
Search query.
start_date (String) (defaults to: nil) —
Start date of the period to analyze, in YYYY-MM-DD format.
end_date (String) (defaults to: nil) —
End date of the period to analyze, in YYYY-MM-DD format.
limit (Integer) (defaults to: nil) —
Number of items to return. (default to 10)
offset (Integer) (defaults to: nil) —
Position of the first item to return. (default to 0)
tags (String) (defaults to: nil) —
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Segment your analytics data.
request_options: —
The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

(GetTopFilterForAttributeResponse)

# File 'lib/algolia/api/analytics_client.rb', line 1401

def get_top_filter_for_attribute(
  attribute,
  index,
  search = nil,
  start_date = nil,
  end_date = nil,
  limit = nil,
  offset = nil,
  tags = nil,
  request_options = {}
)
  response = get_top_filter_for_attribute_with_http_info(
    attribute,
    index,
    search,
    start_date,
    end_date,
    limit,
    offset,
    tags,
    request_options
  )
  @api_client.deserialize(
    response.body,
    request_options[:debug_return_type] || "Analytics::GetTopFilterForAttributeResponse"
  )
end

#get_top_filter_for_attribute_with_http_info(attribute, index, search = nil, start_date = nil, end_date = nil, limit = nil, offset = nil, tags = nil, request_options = {}) ⇒ `Http::Response`

Retrieves the 1,000 most frequent filter (facet) values for a filter attribute. These are attributes of your records that you included in the attributesForFaceting setting.

Required API Key ACLs:

- analytics

Parameters:

attribute (String) —
Attribute name. (required)
index (String) —
Index name. (required)
search (String) (defaults to: nil) —
Search query.
start_date (String) (defaults to: nil) —
Start date of the period to analyze, in YYYY-MM-DD format.
end_date (String) (defaults to: nil) —
End date of the period to analyze, in YYYY-MM-DD format.
limit (Integer) (defaults to: nil) —
Number of items to return. (default to 10)
offset (Integer) (defaults to: nil) —
Position of the first item to return. (default to 0)
tags (String) (defaults to: nil) —
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Segment your analytics data.
request_options: —
The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

(Http::Response) —
the response

# File 'lib/algolia/api/analytics_client.rb', line 1333

def get_top_filter_for_attribute_with_http_info(
  attribute,
  index,
  search = nil,
  start_date = nil,
  end_date = nil,
  limit = nil,
  offset = nil,
  tags = nil,
  request_options = {}
)
  # verify the required parameter 'attribute' is set
  if @api_client.config.client_side_validation && attribute.nil?
    raise ArgumentError, "Parameter `attribute` is required when calling `get_top_filter_for_attribute`."
  end
  # verify the required parameter 'attribute' is not empty
  if @api_client.config.client_side_validation && attribute.empty?
    raise ArgumentError, "Parameter `attribute` is required when calling `get_top_filter_for_attribute`."
  end
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    raise ArgumentError, "Parameter `index` is required when calling `get_top_filter_for_attribute`."
  end
  # verify the required parameter 'index' is not empty
  if @api_client.config.client_side_validation && index.empty?
    raise ArgumentError, "Parameter `index` is required when calling `get_top_filter_for_attribute`."
  end

  path = "/2/filters/{attribute}".sub("{" + "attribute" + "}", Transport.encode_uri(attribute.to_s))
  query_params = {}
  query_params[:index] = index
  query_params[:search] = search unless search.nil?
  query_params[:startDate] = start_date unless start_date.nil?
  query_params[:endDate] = end_date unless end_date.nil?
  query_params[:limit] = limit unless limit.nil?
  query_params[:offset] = offset unless offset.nil?
  query_params[:tags] = tags unless tags.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"AnalyticsClient.get_top_filter_for_attribute",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#get_top_filters_no_results(index, search = nil, start_date = nil, end_date = nil, limit = nil, offset = nil, tags = nil, request_options = {}) ⇒ `GetTopFiltersNoResultsResponse`

Retrieves the 1,000 most frequently used filters for a search that didn't return any results. To get the most frequent searches without results, use the Retrieve searches without results operation.

Required API Key ACLs:

- analytics

Parameters:

index (String) —
Index name. (required)
search (String) (defaults to: nil) —
Search query.
start_date (String) (defaults to: nil) —
Start date of the period to analyze, in YYYY-MM-DD format.
end_date (String) (defaults to: nil) —
End date of the period to analyze, in YYYY-MM-DD format.
limit (Integer) (defaults to: nil) —
Number of items to return. (default to 10)
offset (Integer) (defaults to: nil) —
Position of the first item to return. (default to 0)
tags (String) (defaults to: nil) —
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Segment your analytics data.
request_options: —
The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

(GetTopFiltersNoResultsResponse)

# File 'lib/algolia/api/analytics_client.rb', line 1500

def get_top_filters_no_results(
  index,
  search = nil,
  start_date = nil,
  end_date = nil,
  limit = nil,
  offset = nil,
  tags = nil,
  request_options = {}
)
  response = get_top_filters_no_results_with_http_info(
    index,
    search,
    start_date,
    end_date,
    limit,
    offset,
    tags,
    request_options
  )
  @api_client.deserialize(
    response.body,
    request_options[:debug_return_type] || "Analytics::GetTopFiltersNoResultsResponse"
  )
end

#get_top_filters_no_results_with_http_info(index, search = nil, start_date = nil, end_date = nil, limit = nil, offset = nil, tags = nil, request_options = {}) ⇒ `Http::Response`

Retrieves the 1,000 most frequently used filters for a search that didn't return any results. To get the most frequent searches without results, use the Retrieve searches without results operation.

Required API Key ACLs:

- analytics

Parameters:

index (String) —
Index name. (required)
search (String) (defaults to: nil) —
Search query.
start_date (String) (defaults to: nil) —
Start date of the period to analyze, in YYYY-MM-DD format.
end_date (String) (defaults to: nil) —
End date of the period to analyze, in YYYY-MM-DD format.
limit (Integer) (defaults to: nil) —
Number of items to return. (default to 10)
offset (Integer) (defaults to: nil) —
Position of the first item to return. (default to 0)
tags (String) (defaults to: nil) —
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Segment your analytics data.
request_options: —
The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

(Http::Response) —
the response

# File 'lib/algolia/api/analytics_client.rb', line 1442

def get_top_filters_no_results_with_http_info(
  index,
  search = nil,
  start_date = nil,
  end_date = nil,
  limit = nil,
  offset = nil,
  tags = nil,
  request_options = {}
)
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    raise ArgumentError, "Parameter `index` is required when calling `get_top_filters_no_results`."
  end
  # verify the required parameter 'index' is not empty
  if @api_client.config.client_side_validation && index.empty?
    raise ArgumentError, "Parameter `index` is required when calling `get_top_filters_no_results`."
  end

  path = "/2/filters/noResults"
  query_params = {}
  query_params[:index] = index
  query_params[:search] = search unless search.nil?
  query_params[:startDate] = start_date unless start_date.nil?
  query_params[:endDate] = end_date unless end_date.nil?
  query_params[:limit] = limit unless limit.nil?
  query_params[:offset] = offset unless offset.nil?
  query_params[:tags] = tags unless tags.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"AnalyticsClient.get_top_filters_no_results",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#get_top_hits(index, search = nil, click_analytics = nil, revenue_analytics = nil, start_date = nil, end_date = nil, limit = nil, offset = nil, tags = nil, request_options = {}) ⇒ `GetTopHitsResponse`

Retrieves the object IDs of the 1,000 most frequent search results. If you set the clickAnalytics query parameter to true, the response also includes: - Tracked searches count. Tracked searches are Search API requests with clickAnalytics set to true. This differs from the response's count, which includes searches where clickAnalytics is false. - Click count - Click-through rate (CTR) - Conversion count - Conversion rate (CR) - Average click position If you set the revenueAnalytics parameter to true, the response also includes: - Add-to-cart count - Add-to-cart rate (ATCR) - Purchase count - Purchase rate - Revenue details for each currency There's a difference between 0% rates and null rates: - Null means there were no queries. Algolia didn't receive any events, so rates are null. - 0% rates mean there were queries but no click or conversion events were received.

Required API Key ACLs:

- analytics

Parameters:

index (String) —
Index name. (required)
search (String) (defaults to: nil) —
Search query.
click_analytics (Boolean) (defaults to: nil) —
Whether to include metrics related to click and conversion events in the response. (default to false)
revenue_analytics (Boolean) (defaults to: nil) —
Whether to include metrics related to revenue events in the response. (default to false)
start_date (String) (defaults to: nil) —
Start date of the period to analyze, in YYYY-MM-DD format.
end_date (String) (defaults to: nil) —
End date of the period to analyze, in YYYY-MM-DD format.
limit (Integer) (defaults to: nil) —
Number of items to return. (default to 10)
offset (Integer) (defaults to: nil) —
Position of the first item to return. (default to 0)
tags (String) (defaults to: nil) —
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Segment your analytics data.
request_options: —
The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

(GetTopHitsResponse)

# File 'lib/algolia/api/analytics_client.rb', line 1605

def get_top_hits(
  index,
  search = nil,
  click_analytics = nil,
  revenue_analytics = nil,
  start_date = nil,
  end_date = nil,
  limit = nil,
  offset = nil,
  tags = nil,
  request_options = {}
)
  response = get_top_hits_with_http_info(
    index,
    search,
    click_analytics,
    revenue_analytics,
    start_date,
    end_date,
    limit,
    offset,
    tags,
    request_options
  )
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Analytics::GetTopHitsResponse")
end

#get_top_hits_with_http_info(index, search = nil, click_analytics = nil, revenue_analytics = nil, start_date = nil, end_date = nil, limit = nil, offset = nil, tags = nil, request_options = {}) ⇒ `Http::Response`

Retrieves the object IDs of the 1,000 most frequent search results. If you set the clickAnalytics query parameter to true, the response also includes: - Tracked searches count. Tracked searches are Search API requests with clickAnalytics set to true. This differs from the response's count, which includes searches where clickAnalytics is false. - Click count - Click-through rate (CTR) - Conversion count - Conversion rate (CR) - Average click position If you set the revenueAnalytics parameter to true, the response also includes: - Add-to-cart count - Add-to-cart rate (ATCR) - Purchase count - Purchase rate - Revenue details for each currency There's a difference between 0% rates and null rates: - Null means there were no queries. Algolia didn't receive any events, so rates are null. - 0% rates mean there were queries but no click or conversion events were received.

Required API Key ACLs:

- analytics

Parameters:

index (String) —
Index name. (required)
search (String) (defaults to: nil) —
Search query.
click_analytics (Boolean) (defaults to: nil) —
Whether to include metrics related to click and conversion events in the response. (default to false)
revenue_analytics (Boolean) (defaults to: nil) —
Whether to include metrics related to revenue events in the response. (default to false)
start_date (String) (defaults to: nil) —
Start date of the period to analyze, in YYYY-MM-DD format.
end_date (String) (defaults to: nil) —
End date of the period to analyze, in YYYY-MM-DD format.
limit (Integer) (defaults to: nil) —
Number of items to return. (default to 10)
offset (Integer) (defaults to: nil) —
Position of the first item to return. (default to 0)
tags (String) (defaults to: nil) —
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Segment your analytics data.
request_options: —
The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

(Http::Response) —
the response

# File 'lib/algolia/api/analytics_client.rb', line 1541

def get_top_hits_with_http_info(
  index,
  search = nil,
  click_analytics = nil,
  revenue_analytics = nil,
  start_date = nil,
  end_date = nil,
  limit = nil,
  offset = nil,
  tags = nil,
  request_options = {}
)
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    raise ArgumentError, "Parameter `index` is required when calling `get_top_hits`."
  end
  # verify the required parameter 'index' is not empty
  if @api_client.config.client_side_validation && index.empty?
    raise ArgumentError, "Parameter `index` is required when calling `get_top_hits`."
  end

  path = "/2/hits"
  query_params = {}
  query_params[:index] = index
  query_params[:search] = search unless search.nil?
  query_params[:clickAnalytics] = click_analytics unless click_analytics.nil?
  query_params[:revenueAnalytics] = revenue_analytics unless revenue_analytics.nil?
  query_params[:startDate] = start_date unless start_date.nil?
  query_params[:endDate] = end_date unless end_date.nil?
  query_params[:limit] = limit unless limit.nil?
  query_params[:offset] = offset unless offset.nil?
  query_params[:tags] = tags unless tags.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"AnalyticsClient.get_top_hits",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#get_top_searches(index, click_analytics = nil, revenue_analytics = nil, start_date = nil, end_date = nil, order_by = nil, direction = nil, limit = nil, offset = nil, tags = nil, request_options = {}) ⇒ `GetTopSearchesResponse`

Returns the most popular searches. For each search, it also includes the average number of hits. If you set the clickAnalytics query parameter to true, the response also includes: - Tracked searches count Tracked searches are Search API requests with clickAnalytics set to true. This differs from the response's count, which includes searches where clickAnalytics is false. - Click count - Click-through rate (CTR) - Conversion count - Conversion rate (CR) - Average click position If you set the revenueAnalytics query parameter to true, the response also includes: - Add-to-cart count - Add-to-cart rate (ATCR) - Purchase count - Purchase rate - Revenue details for each currency There's a difference between 0% rates and null rates: - Null means there were no queries. Algolia didn't receive any events, so rates are null. - 0% rates mean there were queries but no click or conversion events were received.

Required API Key ACLs:

- analytics

Parameters:

index (String) —
Index name. (required)
click_analytics (Boolean) (defaults to: nil) —
Whether to include metrics related to click and conversion events in the response. (default to false)
revenue_analytics (Boolean) (defaults to: nil) —
Whether to include metrics related to revenue events in the response. (default to false)
start_date (String) (defaults to: nil) —
Start date of the period to analyze, in YYYY-MM-DD format.
end_date (String) (defaults to: nil) —
End date of the period to analyze, in YYYY-MM-DD format.
order_by (OrderBy) (defaults to: nil) —
Attribute by which to order the response items. If the clickAnalytics parameter is false, only searchCount is available. (default to 'searchCount')
direction (Direction) (defaults to: nil) —
Sorting direction of the results: ascending or descending. (default to 'asc')
limit (Integer) (defaults to: nil) —
Number of items to return. (default to 10)
offset (Integer) (defaults to: nil) —
Position of the first item to return. (default to 0)
tags (String) (defaults to: nil) —
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Segment your analytics data.
request_options: —
The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

(GetTopSearchesResponse)

# File 'lib/algolia/api/analytics_client.rb', line 1715

def get_top_searches(
  index,
  click_analytics = nil,
  revenue_analytics = nil,
  start_date = nil,
  end_date = nil,
  order_by = nil,
  direction = nil,
  limit = nil,
  offset = nil,
  tags = nil,
  request_options = {}
)
  response = get_top_searches_with_http_info(
    index,
    click_analytics,
    revenue_analytics,
    start_date,
    end_date,
    order_by,
    direction,
    limit,
    offset,
    tags,
    request_options
  )
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Analytics::GetTopSearchesResponse")
end

#get_top_searches_with_http_info(index, click_analytics = nil, revenue_analytics = nil, start_date = nil, end_date = nil, order_by = nil, direction = nil, limit = nil, offset = nil, tags = nil, request_options = {}) ⇒ `Http::Response`

Returns the most popular searches. For each search, it also includes the average number of hits. If you set the clickAnalytics query parameter to true, the response also includes: - Tracked searches count Tracked searches are Search API requests with clickAnalytics set to true. This differs from the response's count, which includes searches where clickAnalytics is false. - Click count - Click-through rate (CTR) - Conversion count - Conversion rate (CR) - Average click position If you set the revenueAnalytics query parameter to true, the response also includes: - Add-to-cart count - Add-to-cart rate (ATCR) - Purchase count - Purchase rate - Revenue details for each currency There's a difference between 0% rates and null rates: - Null means there were no queries. Algolia didn't receive any events, so rates are null. - 0% rates mean there were queries but no click or conversion events were received.

Required API Key ACLs:

- analytics

Parameters:

index (String) —
Index name. (required)
click_analytics (Boolean) (defaults to: nil) —
Whether to include metrics related to click and conversion events in the response. (default to false)
revenue_analytics (Boolean) (defaults to: nil) —
Whether to include metrics related to revenue events in the response. (default to false)
start_date (String) (defaults to: nil) —
Start date of the period to analyze, in YYYY-MM-DD format.
end_date (String) (defaults to: nil) —
End date of the period to analyze, in YYYY-MM-DD format.
order_by (OrderBy) (defaults to: nil) —
Attribute by which to order the response items. If the clickAnalytics parameter is false, only searchCount is available. (default to 'searchCount')
direction (Direction) (defaults to: nil) —
Sorting direction of the results: ascending or descending. (default to 'asc')
limit (Integer) (defaults to: nil) —
Number of items to return. (default to 10)
offset (Integer) (defaults to: nil) —
Position of the first item to return. (default to 0)
tags (String) (defaults to: nil) —
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Segment your analytics data.
request_options: —
The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

(Http::Response) —
the response

# File 'lib/algolia/api/analytics_client.rb', line 1648

def get_top_searches_with_http_info(
  index,
  click_analytics = nil,
  revenue_analytics = nil,
  start_date = nil,
  end_date = nil,
  order_by = nil,
  direction = nil,
  limit = nil,
  offset = nil,
  tags = nil,
  request_options = {}
)
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    raise ArgumentError, "Parameter `index` is required when calling `get_top_searches`."
  end
  # verify the required parameter 'index' is not empty
  if @api_client.config.client_side_validation && index.empty?
    raise ArgumentError, "Parameter `index` is required when calling `get_top_searches`."
  end

  path = "/2/searches"
  query_params = {}
  query_params[:index] = index
  query_params[:clickAnalytics] = click_analytics unless click_analytics.nil?
  query_params[:revenueAnalytics] = revenue_analytics unless revenue_analytics.nil?
  query_params[:startDate] = start_date unless start_date.nil?
  query_params[:endDate] = end_date unless end_date.nil?
  query_params[:orderBy] = order_by unless order_by.nil?
  query_params[:direction] = direction unless direction.nil?
  query_params[:limit] = limit unless limit.nil?
  query_params[:offset] = offset unless offset.nil?
  query_params[:tags] = tags unless tags.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"AnalyticsClient.get_top_searches",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#get_users_count(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ `GetUsersCountResponse`

Retrieves the number of unique users within a time range, including a daily breakdown. Since it returns the number of unique users, the sum of the daily values might be different from the total number. By default: - Algolia distinguishes search users by their IP address, unless you include a pseudonymous user identifier in your search requests with the userToken API parameter or x-algolia-usertoken request header. - The analyzed period includes the last eight days including the current day.

Required API Key ACLs:

- analytics

Parameters:

index (String) —
Index name. (required)
start_date (String) (defaults to: nil) —
Start date of the period to analyze, in YYYY-MM-DD format.
end_date (String) (defaults to: nil) —
End date of the period to analyze, in YYYY-MM-DD format.
tags (String) (defaults to: nil) —
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Segment your analytics data.
request_options: —
The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

(GetUsersCountResponse)

# File 'lib/algolia/api/analytics_client.rb', line 1797

def get_users_count(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
  response = get_users_count_with_http_info(index, start_date, end_date, tags, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Analytics::GetUsersCountResponse")
end

#get_users_count_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ `Http::Response`

Retrieves the number of unique users within a time range, including a daily breakdown. Since it returns the number of unique users, the sum of the daily values might be different from the total number. By default: - Algolia distinguishes search users by their IP address, unless you include a pseudonymous user identifier in your search requests with the userToken API parameter or x-algolia-usertoken request header. - The analyzed period includes the last eight days including the current day.

Required API Key ACLs:

- analytics

Parameters:

index (String) —
Index name. (required)
start_date (String) (defaults to: nil) —
Start date of the period to analyze, in YYYY-MM-DD format.
end_date (String) (defaults to: nil) —
End date of the period to analyze, in YYYY-MM-DD format.
tags (String) (defaults to: nil) —
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Segment your analytics data.
request_options: —
The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

(Http::Response) —
the response

# File 'lib/algolia/api/analytics_client.rb', line 1754

def get_users_count_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    raise ArgumentError, "Parameter `index` is required when calling `get_users_count`."
  end
  # verify the required parameter 'index' is not empty
  if @api_client.config.client_side_validation && index.empty?
    raise ArgumentError, "Parameter `index` is required when calling `get_users_count`."
  end

  path = "/2/users/count"
  query_params = {}
  query_params[:index] = index
  query_params[:startDate] = start_date unless start_date.nil?
  query_params[:endDate] = end_date unless end_date.nil?
  query_params[:tags] = tags unless tags.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body]

  new_options = request_options.merge(
    :operation => :"AnalyticsClient.get_users_count",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:GET, path, new_options)
end

#query_patterns_distribution(distribution_payload, index = nil, request_options = {}) ⇒ `Hash<String, Object>`

Buckets one or more numeric fields into histograms and returns an object keyed by histogram<Field>, each mapping a bin label to a count. distributions and parameters are required; filters is optional. Discover valid field kinds per domain with /3/patterns/fields.

Required API Key ACLs:

- analytics

Parameters:

distribution_payload (DistributionPayload) —
(required)
index (String) (defaults to: nil) —
Comma-separated list of indices the request runs on, used for authorization. Required for index-restricted API keys and must match the indices supplied in the request body's indices parameter; optional for unrestricted keys.
request_options: —
The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

(Hash<String, Object>)

# File 'lib/algolia/api/analytics_client.rb', line 1844

def query_patterns_distribution(distribution_payload, index = nil, request_options = {})
  response = query_patterns_distribution_with_http_info(distribution_payload, index, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Hash<String, Object>")
end

#query_patterns_distribution_with_http_info(distribution_payload, index = nil, request_options = {}) ⇒ `Http::Response`

Buckets one or more numeric fields into histograms and returns an object keyed by histogram<Field>, each mapping a bin label to a count. distributions and parameters are required; filters is optional. Discover valid field kinds per domain with /3/patterns/fields.

Required API Key ACLs:

- analytics

Parameters:

distribution_payload (DistributionPayload) —
(required)
index (String) (defaults to: nil) —
Comma-separated list of indices the request runs on, used for authorization. Required for index-restricted API keys and must match the indices supplied in the request body's indices parameter; optional for unrestricted keys.
request_options: —
The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

(Http::Response) —
the response

# File 'lib/algolia/api/analytics_client.rb', line 1810

def query_patterns_distribution_with_http_info(distribution_payload, index = nil, request_options = {})
  # verify the required parameter 'distribution_payload' is set
  if @api_client.config.client_side_validation && distribution_payload.nil?
    raise ArgumentError, "Parameter `distribution_payload` is required when calling `query_patterns_distribution`."
  end

  path = "/3/patterns/distribution"
  query_params = {}
  query_params[:index] = index unless index.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body] || @api_client.object_to_http_body(distribution_payload)

  new_options = request_options.merge(
    :operation => :"AnalyticsClient.query_patterns_distribution",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:POST, path, new_options)
end

#query_patterns_scalar(scalar_payload, index = nil, request_options = {}) ⇒ `Hash<String, Object>`

Aggregates the requested metrics over the whole period and returns a single object keyed by metric kind. metrics and parameters are required; filters is optional. Discover valid field kinds per domain with /3/patterns/fields.

Required API Key ACLs:

- analytics

Parameters:

scalar_payload (ScalarPayload) —
(required)
index (String) (defaults to: nil) —
Comma-separated list of indices the request runs on, used for authorization. Required for index-restricted API keys and must match the indices supplied in the request body's indices parameter; optional for unrestricted keys.
request_options: —
The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

(Hash<String, Object>)

# File 'lib/algolia/api/analytics_client.rb', line 1891

def query_patterns_scalar(scalar_payload, index = nil, request_options = {})
  response = query_patterns_scalar_with_http_info(scalar_payload, index, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Hash<String, Object>")
end

#query_patterns_scalar_with_http_info(scalar_payload, index = nil, request_options = {}) ⇒ `Http::Response`

Aggregates the requested metrics over the whole period and returns a single object keyed by metric kind. metrics and parameters are required; filters is optional. Discover valid field kinds per domain with /3/patterns/fields.

Required API Key ACLs:

- analytics

Parameters:

scalar_payload (ScalarPayload) —
(required)
index (String) (defaults to: nil) —
Comma-separated list of indices the request runs on, used for authorization. Required for index-restricted API keys and must match the indices supplied in the request body's indices parameter; optional for unrestricted keys.
request_options: —
The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

(Http::Response) —
the response

# File 'lib/algolia/api/analytics_client.rb', line 1857

def query_patterns_scalar_with_http_info(scalar_payload, index = nil, request_options = {})
  # verify the required parameter 'scalar_payload' is set
  if @api_client.config.client_side_validation && scalar_payload.nil?
    raise ArgumentError, "Parameter `scalar_payload` is required when calling `query_patterns_scalar`."
  end

  path = "/3/patterns/scalar"
  query_params = {}
  query_params[:index] = index unless index.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body] || @api_client.object_to_http_body(scalar_payload)

  new_options = request_options.merge(
    :operation => :"AnalyticsClient.query_patterns_scalar",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:POST, path, new_options)
end

#query_patterns_table(table_payload, index = nil, request_options = {}) ⇒ `TableResponse`

Returns rows, each a flat object of the requested fields. metrics and parameters are required; groupBy, filters, and orderBy are optional, though orderBy is required when groupBy is set. Discover valid field kinds per domain with /3/patterns/fields.

Required API Key ACLs:

- analytics

Parameters:

table_payload (TablePayload) —
(required)
index (String) (defaults to: nil) —
Comma-separated list of indices the request runs on, used for authorization. Required for index-restricted API keys and must match the indices supplied in the request body's indices parameter; optional for unrestricted keys.
request_options: —
The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

(TableResponse)

# File 'lib/algolia/api/analytics_client.rb', line 1938

def query_patterns_table(table_payload, index = nil, request_options = {})
  response = query_patterns_table_with_http_info(table_payload, index, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Analytics::TableResponse")
end

#query_patterns_table_with_http_info(table_payload, index = nil, request_options = {}) ⇒ `Http::Response`

Returns rows, each a flat object of the requested fields. metrics and parameters are required; groupBy, filters, and orderBy are optional, though orderBy is required when groupBy is set. Discover valid field kinds per domain with /3/patterns/fields.

Required API Key ACLs:

- analytics

Parameters:

table_payload (TablePayload) —
(required)
index (String) (defaults to: nil) —
Comma-separated list of indices the request runs on, used for authorization. Required for index-restricted API keys and must match the indices supplied in the request body's indices parameter; optional for unrestricted keys.
request_options: —
The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

(Http::Response) —
the response

# File 'lib/algolia/api/analytics_client.rb', line 1904

def query_patterns_table_with_http_info(table_payload, index = nil, request_options = {})
  # verify the required parameter 'table_payload' is set
  if @api_client.config.client_side_validation && table_payload.nil?
    raise ArgumentError, "Parameter `table_payload` is required when calling `query_patterns_table`."
  end

  path = "/3/patterns/table"
  query_params = {}
  query_params[:index] = index unless index.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body] || @api_client.object_to_http_body(table_payload)

  new_options = request_options.merge(
    :operation => :"AnalyticsClient.query_patterns_table",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:POST, path, new_options)
end

#query_patterns_timeseries(timeseries_payload, index = nil, request_options = {}) ⇒ `TimeseriesResponse`

Returns one time series per groupBy combination, each with period totals and a per-day metric breakdown. metrics and parameters are required; groupBy and filters are optional. Discover valid field kinds per domain with /3/patterns/fields.

Required API Key ACLs:

- analytics

Parameters:

timeseries_payload (TimeseriesPayload) —
(required)
index (String) (defaults to: nil) —
Comma-separated list of indices the request runs on, used for authorization. Required for index-restricted API keys and must match the indices supplied in the request body's indices parameter; optional for unrestricted keys.
request_options: —
The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

(TimeseriesResponse)

# File 'lib/algolia/api/analytics_client.rb', line 1985

def query_patterns_timeseries(timeseries_payload, index = nil, request_options = {})
  response = query_patterns_timeseries_with_http_info(timeseries_payload, index, request_options)
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Analytics::TimeseriesResponse")
end

#query_patterns_timeseries_with_http_info(timeseries_payload, index = nil, request_options = {}) ⇒ `Http::Response`

Returns one time series per groupBy combination, each with period totals and a per-day metric breakdown. metrics and parameters are required; groupBy and filters are optional. Discover valid field kinds per domain with /3/patterns/fields.

Required API Key ACLs:

- analytics

Parameters:

timeseries_payload (TimeseriesPayload) —
(required)
index (String) (defaults to: nil) —
Comma-separated list of indices the request runs on, used for authorization. Required for index-restricted API keys and must match the indices supplied in the request body's indices parameter; optional for unrestricted keys.
request_options: —
The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

Returns:

(Http::Response) —
the response

# File 'lib/algolia/api/analytics_client.rb', line 1951

def query_patterns_timeseries_with_http_info(timeseries_payload, index = nil, request_options = {})
  # verify the required parameter 'timeseries_payload' is set
  if @api_client.config.client_side_validation && timeseries_payload.nil?
    raise ArgumentError, "Parameter `timeseries_payload` is required when calling `query_patterns_timeseries`."
  end

  path = "/3/patterns/timeseries"
  query_params = {}
  query_params[:index] = index unless index.nil?
  query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
  header_params = {}
  header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?

  post_body = request_options[:debug_body] || @api_client.object_to_http_body(timeseries_payload)

  new_options = request_options.merge(
    :operation => :"AnalyticsClient.query_patterns_timeseries",
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :use_read_transporter => false
  )

  @api_client.call_api(:POST, path, new_options)
end

#set_client_api_key(api_key) ⇒ `void`

This method returns an undefined value.

Helper method to switch the API key used to authenticate the requests.

Parameters:

api_key (String) —
the new API key to use.

# File 'lib/algolia/api/analytics_client.rb', line 61

def set_client_api_key(api_key)
  @api_client.set_client_api_key(api_key)

  self
end

Class: Algolia::AnalyticsClient

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config = nil) ⇒ AnalyticsClient

Instance Attribute Details

#api_client ⇒ Object

Class Method Details

.create(app_id, api_key, region = nil, opts = {}) ⇒ Object

.create_with_config(config) ⇒ Object

Instance Method Details

#add_user_agent_segment(segment, version = nil) ⇒ Object

#custom_delete(path, parameters = nil, request_options = {}) ⇒ Object

#custom_delete_with_http_info(path, parameters = nil, request_options = {}) ⇒ Http::Response

#custom_get(path, parameters = nil, request_options = {}) ⇒ Object

#custom_get_with_http_info(path, parameters = nil, request_options = {}) ⇒ Http::Response

#custom_post(path, parameters = nil, body = nil, request_options = {}) ⇒ Object

#custom_post_with_http_info(path, parameters = nil, body = nil, request_options = {}) ⇒ Http::Response

#custom_put(path, parameters = nil, body = nil, request_options = {}) ⇒ Object

#custom_put_with_http_info(path, parameters = nil, body = nil, request_options = {}) ⇒ Http::Response

#get_add_to_cart_rate(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ GetAddToCartRateResponse

#get_add_to_cart_rate_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ Http::Response

#get_average_click_position(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ GetAverageClickPositionResponse

#get_average_click_position_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ Http::Response

#get_click_positions(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ GetClickPositionsResponse

#get_click_positions_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ Http::Response

#get_click_through_rate(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ GetClickThroughRateResponse

#get_click_through_rate_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ Http::Response

#get_conversion_rate(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ GetConversionRateResponse

#get_conversion_rate_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ Http::Response

#get_no_click_rate(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ GetNoClickRateResponse

#get_no_click_rate_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ Http::Response

#get_no_results_rate(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ GetNoResultsRateResponse

#get_no_results_rate_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ Http::Response

#get_patterns_fields(request_options = {}) ⇒ Catalog

#get_patterns_fields_with_http_info(request_options = {}) ⇒ Http::Response

#get_purchase_rate(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ GetPurchaseRateResponse

#get_purchase_rate_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ Http::Response

#get_revenue(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ GetRevenue

#get_revenue_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ Http::Response

#get_searches_count(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ GetSearchesCountResponse

#get_searches_count_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ Http::Response

#get_searches_no_clicks(index, start_date = nil, end_date = nil, limit = nil, offset = nil, tags = nil, request_options = {}) ⇒ GetSearchesNoClicksResponse

#get_searches_no_clicks_with_http_info(index, start_date = nil, end_date = nil, limit = nil, offset = nil, tags = nil, request_options = {}) ⇒ Http::Response

#get_searches_no_results(index, start_date = nil, end_date = nil, limit = nil, offset = nil, tags = nil, request_options = {}) ⇒ GetSearchesNoResultsResponse

#get_searches_no_results_with_http_info(index, start_date = nil, end_date = nil, limit = nil, offset = nil, tags = nil, request_options = {}) ⇒ Http::Response

#get_status(index, request_options = {}) ⇒ GetStatusResponse

#get_status_with_http_info(index, request_options = {}) ⇒ Http::Response

#get_top_countries(index, start_date = nil, end_date = nil, limit = nil, offset = nil, tags = nil, request_options = {}) ⇒ GetTopCountriesResponse

#get_top_countries_with_http_info(index, start_date = nil, end_date = nil, limit = nil, offset = nil, tags = nil, request_options = {}) ⇒ Http::Response

#get_top_filter_attributes(index, search = nil, start_date = nil, end_date = nil, limit = nil, offset = nil, tags = nil, request_options = {}) ⇒ GetTopFilterAttributesResponse

#get_top_filter_attributes_with_http_info(index, search = nil, start_date = nil, end_date = nil, limit = nil, offset = nil, tags = nil, request_options = {}) ⇒ Http::Response

#get_top_filter_for_attribute(attribute, index, search = nil, start_date = nil, end_date = nil, limit = nil, offset = nil, tags = nil, request_options = {}) ⇒ GetTopFilterForAttributeResponse

#get_top_filter_for_attribute_with_http_info(attribute, index, search = nil, start_date = nil, end_date = nil, limit = nil, offset = nil, tags = nil, request_options = {}) ⇒ Http::Response

#get_top_filters_no_results(index, search = nil, start_date = nil, end_date = nil, limit = nil, offset = nil, tags = nil, request_options = {}) ⇒ GetTopFiltersNoResultsResponse

#get_top_filters_no_results_with_http_info(index, search = nil, start_date = nil, end_date = nil, limit = nil, offset = nil, tags = nil, request_options = {}) ⇒ Http::Response

#get_top_hits(index, search = nil, click_analytics = nil, revenue_analytics = nil, start_date = nil, end_date = nil, limit = nil, offset = nil, tags = nil, request_options = {}) ⇒ GetTopHitsResponse

#get_top_hits_with_http_info(index, search = nil, click_analytics = nil, revenue_analytics = nil, start_date = nil, end_date = nil, limit = nil, offset = nil, tags = nil, request_options = {}) ⇒ Http::Response

#get_top_searches(index, click_analytics = nil, revenue_analytics = nil, start_date = nil, end_date = nil, order_by = nil, direction = nil, limit = nil, offset = nil, tags = nil, request_options = {}) ⇒ GetTopSearchesResponse

#get_top_searches_with_http_info(index, click_analytics = nil, revenue_analytics = nil, start_date = nil, end_date = nil, order_by = nil, direction = nil, limit = nil, offset = nil, tags = nil, request_options = {}) ⇒ Http::Response

#get_users_count(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ GetUsersCountResponse

#get_users_count_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ Http::Response

#query_patterns_distribution(distribution_payload, index = nil, request_options = {}) ⇒ Hash<String, Object>

#query_patterns_distribution_with_http_info(distribution_payload, index = nil, request_options = {}) ⇒ Http::Response

#query_patterns_scalar(scalar_payload, index = nil, request_options = {}) ⇒ Hash<String, Object>

#query_patterns_scalar_with_http_info(scalar_payload, index = nil, request_options = {}) ⇒ Http::Response

#query_patterns_table(table_payload, index = nil, request_options = {}) ⇒ TableResponse

#query_patterns_table_with_http_info(table_payload, index = nil, request_options = {}) ⇒ Http::Response

#query_patterns_timeseries(timeseries_payload, index = nil, request_options = {}) ⇒ TimeseriesResponse

#query_patterns_timeseries_with_http_info(timeseries_payload, index = nil, request_options = {}) ⇒ Http::Response

#set_client_api_key(api_key) ⇒ void

#initialize(config = nil) ⇒ `AnalyticsClient`

#api_client ⇒ `Object`

.create(app_id, api_key, region = nil, opts = {}) ⇒ `Object`

.create_with_config(config) ⇒ `Object`

#add_user_agent_segment(segment, version = nil) ⇒ `Object`

#custom_delete(path, parameters = nil, request_options = {}) ⇒ `Object`

#custom_delete_with_http_info(path, parameters = nil, request_options = {}) ⇒ `Http::Response`

#custom_get(path, parameters = nil, request_options = {}) ⇒ `Object`

#custom_get_with_http_info(path, parameters = nil, request_options = {}) ⇒ `Http::Response`

#custom_post(path, parameters = nil, body = nil, request_options = {}) ⇒ `Object`

#custom_post_with_http_info(path, parameters = nil, body = nil, request_options = {}) ⇒ `Http::Response`

#custom_put(path, parameters = nil, body = nil, request_options = {}) ⇒ `Object`

#custom_put_with_http_info(path, parameters = nil, body = nil, request_options = {}) ⇒ `Http::Response`

#get_add_to_cart_rate(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ `GetAddToCartRateResponse`

#get_add_to_cart_rate_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ `Http::Response`

#get_average_click_position(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ `GetAverageClickPositionResponse`

#get_average_click_position_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ `Http::Response`

#get_click_positions(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ `GetClickPositionsResponse`

#get_click_positions_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ `Http::Response`

#get_click_through_rate(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ `GetClickThroughRateResponse`

#get_click_through_rate_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ `Http::Response`

#get_conversion_rate(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ `GetConversionRateResponse`

#get_conversion_rate_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ `Http::Response`

#get_no_click_rate(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ `GetNoClickRateResponse`

#get_no_click_rate_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ `Http::Response`

#get_no_results_rate(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ `GetNoResultsRateResponse`

#get_no_results_rate_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ `Http::Response`

#get_patterns_fields(request_options = {}) ⇒ `Catalog`

#get_patterns_fields_with_http_info(request_options = {}) ⇒ `Http::Response`

#get_purchase_rate(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ `GetPurchaseRateResponse`

#get_purchase_rate_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ `Http::Response`

#get_revenue(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ `GetRevenue`

#get_revenue_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ `Http::Response`

#get_searches_count(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ `GetSearchesCountResponse`

#get_searches_count_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ `Http::Response`

#get_searches_no_clicks(index, start_date = nil, end_date = nil, limit = nil, offset = nil, tags = nil, request_options = {}) ⇒ `GetSearchesNoClicksResponse`

#get_searches_no_clicks_with_http_info(index, start_date = nil, end_date = nil, limit = nil, offset = nil, tags = nil, request_options = {}) ⇒ `Http::Response`

#get_searches_no_results(index, start_date = nil, end_date = nil, limit = nil, offset = nil, tags = nil, request_options = {}) ⇒ `GetSearchesNoResultsResponse`

#get_searches_no_results_with_http_info(index, start_date = nil, end_date = nil, limit = nil, offset = nil, tags = nil, request_options = {}) ⇒ `Http::Response`

#get_status(index, request_options = {}) ⇒ `GetStatusResponse`

#get_status_with_http_info(index, request_options = {}) ⇒ `Http::Response`

#get_top_countries(index, start_date = nil, end_date = nil, limit = nil, offset = nil, tags = nil, request_options = {}) ⇒ `GetTopCountriesResponse`

#get_top_countries_with_http_info(index, start_date = nil, end_date = nil, limit = nil, offset = nil, tags = nil, request_options = {}) ⇒ `Http::Response`

#get_top_filter_attributes(index, search = nil, start_date = nil, end_date = nil, limit = nil, offset = nil, tags = nil, request_options = {}) ⇒ `GetTopFilterAttributesResponse`

#get_top_filter_attributes_with_http_info(index, search = nil, start_date = nil, end_date = nil, limit = nil, offset = nil, tags = nil, request_options = {}) ⇒ `Http::Response`

#get_top_filter_for_attribute(attribute, index, search = nil, start_date = nil, end_date = nil, limit = nil, offset = nil, tags = nil, request_options = {}) ⇒ `GetTopFilterForAttributeResponse`

#get_top_filter_for_attribute_with_http_info(attribute, index, search = nil, start_date = nil, end_date = nil, limit = nil, offset = nil, tags = nil, request_options = {}) ⇒ `Http::Response`

#get_top_filters_no_results(index, search = nil, start_date = nil, end_date = nil, limit = nil, offset = nil, tags = nil, request_options = {}) ⇒ `GetTopFiltersNoResultsResponse`

#get_top_filters_no_results_with_http_info(index, search = nil, start_date = nil, end_date = nil, limit = nil, offset = nil, tags = nil, request_options = {}) ⇒ `Http::Response`

#get_top_hits(index, search = nil, click_analytics = nil, revenue_analytics = nil, start_date = nil, end_date = nil, limit = nil, offset = nil, tags = nil, request_options = {}) ⇒ `GetTopHitsResponse`

#get_top_hits_with_http_info(index, search = nil, click_analytics = nil, revenue_analytics = nil, start_date = nil, end_date = nil, limit = nil, offset = nil, tags = nil, request_options = {}) ⇒ `Http::Response`

#get_top_searches(index, click_analytics = nil, revenue_analytics = nil, start_date = nil, end_date = nil, order_by = nil, direction = nil, limit = nil, offset = nil, tags = nil, request_options = {}) ⇒ `GetTopSearchesResponse`

#get_top_searches_with_http_info(index, click_analytics = nil, revenue_analytics = nil, start_date = nil, end_date = nil, order_by = nil, direction = nil, limit = nil, offset = nil, tags = nil, request_options = {}) ⇒ `Http::Response`

#get_users_count(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ `GetUsersCountResponse`

#get_users_count_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) ⇒ `Http::Response`

#query_patterns_distribution(distribution_payload, index = nil, request_options = {}) ⇒ `Hash<String, Object>`

#query_patterns_distribution_with_http_info(distribution_payload, index = nil, request_options = {}) ⇒ `Http::Response`

#query_patterns_scalar(scalar_payload, index = nil, request_options = {}) ⇒ `Hash<String, Object>`

#query_patterns_scalar_with_http_info(scalar_payload, index = nil, request_options = {}) ⇒ `Http::Response`

#query_patterns_table(table_payload, index = nil, request_options = {}) ⇒ `TableResponse`

#query_patterns_table_with_http_info(table_payload, index = nil, request_options = {}) ⇒ `Http::Response`

#query_patterns_timeseries(timeseries_payload, index = nil, request_options = {}) ⇒ `TimeseriesResponse`

#query_patterns_timeseries_with_http_info(timeseries_payload, index = nil, request_options = {}) ⇒ `Http::Response`

#set_client_api_key(api_key) ⇒ `void`