lib/algolia/api/analytics_client.rb in algolia-3.0.0.alpha.16 vs lib/algolia/api/analytics_client.rb in algolia-3.0.0.alpha.17

- old
+ new

@@ -213,12 +213,12 @@ # Retrieves the add-to-cart rate for all of 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. # # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) - # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze. - # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze. + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. # @param tags [String] 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](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param 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) # @return [Http::Response] the response 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 @@ -252,12 +252,12 @@ # Retrieves the add-to-cart rate for all of 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. # # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) - # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze. - # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze. + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. # @param tags [String] 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](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param 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) # @return [GetAddToCartRateResponse] 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) @@ -267,12 +267,12 @@ # Retrieves the average click position of your search results, including a daily breakdown. The average click position is the average of all clicked search results' 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. # # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) - # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze. - # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze. + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. # @param tags [String] 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](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param 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) # @return [Http::Response] the response 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 @@ -306,12 +306,12 @@ # Retrieves the average click position of your search results, including a daily breakdown. The average click position is the average of all clicked search results' 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. # # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) - # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze. - # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze. + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. # @param tags [String] 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](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param 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) # @return [GetAverageClickPositionResponse] 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) @@ -321,12 +321,12 @@ # 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. # # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) - # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze. - # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze. + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. # @param tags [String] 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](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param 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) # @return [Http::Response] the response 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 @@ -360,12 +360,12 @@ # 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. # # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) - # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze. - # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze. + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. # @param tags [String] 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](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param 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) # @return [GetClickPositionsResponse] 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) @@ -375,12 +375,12 @@ # Retrieves the click-through rate for all of 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. # # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) - # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze. - # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze. + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. # @param tags [String] 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](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param 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) # @return [Http::Response] the response 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 @@ -414,12 +414,12 @@ # Retrieves the click-through rate for all of 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. # # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) - # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze. - # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze. + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. # @param tags [String] 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](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param 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) # @return [GetClickThroughRateResponse] 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) @@ -429,12 +429,12 @@ # Retrieves the conversion rate for all of 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. # # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) - # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze. - # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze. + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. # @param tags [String] 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](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param 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) # @return [Http::Response] the response 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 @@ -468,12 +468,12 @@ # Retrieves the conversion rate for all of 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. # # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) - # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze. - # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze. + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. # @param tags [String] 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](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param 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) # @return [GetConversionRateResponse] 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) @@ -483,12 +483,12 @@ # Retrieves the fraction of searches that didn't lead to any click 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 # @param index [String] Index name. (required) - # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze. - # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze. + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. # @param tags [String] 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](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param 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) # @return [Http::Response] the response 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 @@ -522,12 +522,12 @@ # Retrieves the fraction of searches that didn't lead to any click 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 # @param index [String] Index name. (required) - # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze. - # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze. + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. # @param tags [String] 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](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param 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) # @return [GetNoClickRateResponse] 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) @@ -537,12 +537,12 @@ # Retrieves the fraction of searches that didn't return any results 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 # @param index [String] Index name. (required) - # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze. - # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze. + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. # @param tags [String] 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](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param 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) # @return [Http::Response] the response 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 @@ -576,12 +576,12 @@ # Retrieves the fraction of searches that didn't return any results 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 # @param index [String] Index name. (required) - # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze. - # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze. + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. # @param tags [String] 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](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param 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) # @return [GetNoResultsRateResponse] 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) @@ -591,12 +591,12 @@ # Retrieves the purchase rate for all of 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. # # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) - # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze. - # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze. + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. # @param tags [String] 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](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param 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) # @return [Http::Response] the response 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 @@ -630,12 +630,12 @@ # Retrieves the purchase rate for all of 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. # # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) - # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze. - # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze. + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. # @param tags [String] 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](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param 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) # @return [GetPurchaseRateResponse] 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) @@ -645,12 +645,12 @@ # Retrieves revenue-related metrics, such as the total revenue or the average order value. To retrieve revenue-related metrics, sent purchase events. By default, the analyzed period includes the last eight days including the current day. # # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) - # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze. - # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze. + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. # @param tags [String] 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](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param 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) # @return [Http::Response] the response def get_revenue_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) # verify the required parameter 'index' is set @@ -684,12 +684,12 @@ # Retrieves revenue-related metrics, such as the total revenue or the average order value. To retrieve revenue-related metrics, sent purchase events. By default, the analyzed period includes the last eight days including the current day. # # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) - # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze. - # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze. + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. # @param tags [String] 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](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param 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) # @return [GetRevenue] 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) @@ -699,12 +699,12 @@ # 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 # @param index [String] Index name. (required) - # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze. - # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze. + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. # @param tags [String] 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](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param 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) # @return [Http::Response] the response 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 @@ -738,12 +738,12 @@ # 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 # @param index [String] Index name. (required) - # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze. - # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze. + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. # @param tags [String] 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](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param 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) # @return [GetSearchesCountResponse] 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) @@ -753,12 +753,12 @@ # Retrieves the most popular searches that didn't lead to any clicks, from the 1,000 most frequent searches. # # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) - # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze. - # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze. + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. # @param limit [Integer] Number of items to return. (default to 10) # @param offset [Integer] Position of the first item to return. (default to 0) # @param tags [String] 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](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param 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) # @return [Http::Response] the response @@ -799,12 +799,12 @@ # Retrieves the most popular searches that didn't lead to any clicks, from the 1,000 most frequent searches. # # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) - # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze. - # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze. + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. # @param limit [Integer] Number of items to return. (default to 10) # @param offset [Integer] Position of the first item to return. (default to 0) # @param tags [String] 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](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param 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) # @return [GetSearchesNoClicksResponse] @@ -816,12 +816,12 @@ # Retrieves the most popular searches that didn't return any results. # # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) - # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze. - # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze. + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. # @param limit [Integer] Number of items to return. (default to 10) # @param offset [Integer] Position of the first item to return. (default to 0) # @param tags [String] 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](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param 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) # @return [Http::Response] the response @@ -862,12 +862,12 @@ # Retrieves the most popular searches that didn't return any results. # # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) - # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze. - # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze. + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. # @param limit [Integer] Number of items to return. (default to 10) # @param offset [Integer] Position of the first item to return. (default to 0) # @param tags [String] 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](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param 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) # @return [GetSearchesNoResultsResponse] @@ -924,12 +924,12 @@ # Retrieves the countries with the most searches to your index. # # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) - # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze. - # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze. + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. # @param limit [Integer] Number of items to return. (default to 10) # @param offset [Integer] Position of the first item to return. (default to 0) # @param tags [String] 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](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param 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) # @return [Http::Response] the response @@ -970,12 +970,12 @@ # Retrieves the countries with the most searches to your index. # # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) - # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze. - # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze. + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. # @param limit [Integer] Number of items to return. (default to 10) # @param offset [Integer] Position of the first item to return. (default to 0) # @param tags [String] 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](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param 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) # @return [GetTopCountriesResponse] @@ -988,12 +988,12 @@ # # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) # @param search [String] Search query. - # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze. - # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze. + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. # @param limit [Integer] Number of items to return. (default to 10) # @param offset [Integer] Position of the first item to return. (default to 0) # @param tags [String] 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](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param 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) # @return [Http::Response] the response @@ -1036,12 +1036,12 @@ # # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) # @param search [String] Search query. - # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze. - # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze. + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. # @param limit [Integer] Number of items to return. (default to 10) # @param offset [Integer] Position of the first item to return. (default to 0) # @param tags [String] 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](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param 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) # @return [GetTopFilterAttributesResponse] @@ -1055,12 +1055,12 @@ # Required API Key ACLs: # - analytics # @param attribute [String] Attribute name. (required) # @param index [String] Index name. (required) # @param search [String] Search query. - # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze. - # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze. + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. # @param limit [Integer] Number of items to return. (default to 10) # @param offset [Integer] Position of the first item to return. (default to 0) # @param tags [String] 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](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param 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) # @return [Http::Response] the response @@ -1108,12 +1108,12 @@ # Required API Key ACLs: # - analytics # @param attribute [String] Attribute name. (required) # @param index [String] Index name. (required) # @param search [String] Search query. - # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze. - # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze. + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. # @param limit [Integer] Number of items to return. (default to 10) # @param offset [Integer] Position of the first item to return. (default to 0) # @param tags [String] 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](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param 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) # @return [GetTopFilterForAttributeResponse] @@ -1126,12 +1126,12 @@ # # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) # @param search [String] Search query. - # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze. - # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze. + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. # @param limit [Integer] Number of items to return. (default to 10) # @param offset [Integer] Position of the first item to return. (default to 0) # @param tags [String] 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](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param 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) # @return [Http::Response] the response @@ -1174,12 +1174,12 @@ # # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) # @param search [String] Search query. - # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze. - # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze. + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. # @param limit [Integer] Number of items to return. (default to 10) # @param offset [Integer] Position of the first item to return. (default to 0) # @param tags [String] 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](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param 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) # @return [GetTopFiltersNoResultsResponse] @@ -1194,12 +1194,12 @@ # - analytics # @param index [String] Index name. (required) # @param search [String] Search query. # @param click_analytics [Boolean] Whether to include metrics related to click and conversion events in the response. (default to false) # @param revenue_analytics [Boolean] Whether to include revenue-related metrics in the response. If true, metrics related to click and conversion events are also included in the response. (default to false) - # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze. - # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze. + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. # @param limit [Integer] Number of items to return. (default to 10) # @param offset [Integer] Position of the first item to return. (default to 0) # @param tags [String] 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](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param 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) # @return [Http::Response] the response @@ -1247,12 +1247,12 @@ # - analytics # @param index [String] Index name. (required) # @param search [String] Search query. # @param click_analytics [Boolean] Whether to include metrics related to click and conversion events in the response. (default to false) # @param revenue_analytics [Boolean] Whether to include revenue-related metrics in the response. If true, metrics related to click and conversion events are also included in the response. (default to false) - # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze. - # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze. + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. # @param limit [Integer] Number of items to return. (default to 10) # @param offset [Integer] Position of the first item to return. (default to 0) # @param tags [String] 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](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param 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) # @return [GetTopHitsResponse] @@ -1267,12 +1267,12 @@ # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) # @param click_analytics [Boolean] Whether to include metrics related to click and conversion events in the response. (default to false) # @param revenue_analytics [Boolean] Whether to include revenue-related metrics in the response. If true, metrics related to click and conversion events are also included in the response. (default to false) - # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze. - # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze. + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. # @param order_by [OrderBy] Attribute by which to order the response items. If the `clickAnalytics` parameter is false, only `searchCount` is available. (default to 'searchCount') # @param direction [Direction] Sorting direction of the results: ascending or descending. (default to 'asc') # @param limit [Integer] Number of items to return. (default to 10) # @param offset [Integer] Position of the first item to return. (default to 0) # @param tags [String] 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](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). @@ -1322,12 +1322,12 @@ # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) # @param click_analytics [Boolean] Whether to include metrics related to click and conversion events in the response. (default to false) # @param revenue_analytics [Boolean] Whether to include revenue-related metrics in the response. If true, metrics related to click and conversion events are also included in the response. (default to false) - # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze. - # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze. + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. # @param order_by [OrderBy] Attribute by which to order the response items. If the `clickAnalytics` parameter is false, only `searchCount` is available. (default to 'searchCount') # @param direction [Direction] Sorting direction of the results: ascending or descending. (default to 'asc') # @param limit [Integer] Number of items to return. (default to 10) # @param offset [Integer] Position of the first item to return. (default to 0) # @param tags [String] 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](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). @@ -1342,12 +1342,12 @@ # Retrieves the number of unique users within a time range, including a daily breakdown. Since this endpoint 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. By default, the analyzed period includes the last eight days including the current day. # # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) - # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze. - # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze. + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. # @param tags [String] 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](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param 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) # @return [Http::Response] the response 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 @@ -1381,11 +1381,11 @@ # Retrieves the number of unique users within a time range, including a daily breakdown. Since this endpoint 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. By default, the analyzed period includes the last eight days including the current day. # # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) - # @param start_date [String] Start date (`YYYY-MM-DD`) of the period to analyze. - # @param end_date [String] End date (`YYYY-MM-DD`) of the period to analyze. + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. # @param tags [String] 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](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param 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) # @return [GetUsersCountResponse] 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)