lib/algolia/api/analytics_client.rb in algolia-3.5.2 vs lib/algolia/api/analytics_client.rb in algolia-3.5.3

- old
+ new

@@ -806,12 +806,12 @@ # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) # @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. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10) - # @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0) + # @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 def get_searches_no_clicks_with_http_info( index, @@ -857,12 +857,12 @@ # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) # @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. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10) - # @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0) + # @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] def get_searches_no_clicks( index, @@ -893,12 +893,12 @@ # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) # @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. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10) - # @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0) + # @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 def get_searches_no_results_with_http_info( index, @@ -944,12 +944,12 @@ # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) # @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. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10) - # @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0) + # @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] def get_searches_no_results( index, @@ -1025,12 +1025,12 @@ # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) # @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. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10) - # @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0) + # @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 def get_top_countries_with_http_info( index, @@ -1076,12 +1076,12 @@ # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) # @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. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10) - # @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0) + # @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] def get_top_countries( index, @@ -1105,12 +1105,12 @@ # - analytics # @param index [String] Index name. (required) # @param search [String] Search query. # @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. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10) - # @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0) + # @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 def get_top_filter_attributes_with_http_info( index, @@ -1159,12 +1159,12 @@ # - analytics # @param index [String] Index name. (required) # @param search [String] Search query. # @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. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10) - # @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0) + # @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] def get_top_filter_attributes( index, @@ -1199,12 +1199,12 @@ # @param attribute [String] Attribute name. (required) # @param index [String] Index name. (required) # @param search [String] Search query. # @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. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10) - # @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0) + # @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 def get_top_filter_for_attribute_with_http_info( attribute, @@ -1259,12 +1259,12 @@ # @param attribute [String] Attribute name. (required) # @param index [String] Index name. (required) # @param search [String] Search query. # @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. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10) - # @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0) + # @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] def get_top_filter_for_attribute( attribute, @@ -1300,12 +1300,12 @@ # - analytics # @param index [String] Index name. (required) # @param search [String] Search query. # @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. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10) - # @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0) + # @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 def get_top_filters_no_results_with_http_info( index, @@ -1354,12 +1354,12 @@ # - analytics # @param index [String] Index name. (required) # @param search [String] Search query. # @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. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10) - # @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0) + # @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] def get_top_filters_no_results( index, @@ -1395,12 +1395,12 @@ # @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 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. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10) - # @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0) + # @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 def get_top_hits_with_http_info( index, @@ -1455,12 +1455,12 @@ # @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 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. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10) - # @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0) + # @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] def get_top_hits( index, @@ -1498,12 +1498,12 @@ # @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 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. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10) - # @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0) + # @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 def get_top_searches_with_http_info( index, @@ -1561,11 +1561,11 @@ # @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 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. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10) - # @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0) + # @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 [GetTopSearchesResponse] def get_top_searches( index,