algolia 3.5.0 → 3.5.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (132) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +18 -0
  3. data/Gemfile.lock +1 -1
  4. data/lib/algolia/api/abtesting_client.rb +17 -16
  5. data/lib/algolia/api/analytics_client.rb +173 -333
  6. data/lib/algolia/api/ingestion_client.rb +40 -200
  7. data/lib/algolia/api/insights_client.rb +18 -32
  8. data/lib/algolia/api/monitoring_client.rb +33 -25
  9. data/lib/algolia/api/personalization_client.rb +16 -8
  10. data/lib/algolia/api/query_suggestions_client.rb +17 -9
  11. data/lib/algolia/api/recommend_client.rb +17 -9
  12. data/lib/algolia/api/search_client.rb +63 -110
  13. data/lib/algolia/configuration.rb +16 -1
  14. data/lib/algolia/models/abtesting/ab_test_configuration.rb +0 -2
  15. data/lib/algolia/models/abtesting/ab_tests_variant.rb +0 -18
  16. data/lib/algolia/models/abtesting/ab_tests_variant_search_params.rb +0 -18
  17. data/lib/algolia/models/abtesting/add_ab_tests_request.rb +0 -18
  18. data/lib/algolia/models/abtesting/minimum_detectable_effect.rb +0 -18
  19. data/lib/algolia/models/abtesting/schedule_ab_tests_request.rb +0 -18
  20. data/lib/algolia/models/abtesting/variant.rb +0 -20
  21. data/lib/algolia/models/analytics/click_position.rb +0 -32
  22. data/lib/algolia/models/analytics/daily_add_to_cart_rates.rb +0 -28
  23. data/lib/algolia/models/analytics/daily_average_clicks.rb +0 -24
  24. data/lib/algolia/models/analytics/daily_click_through_rates.rb +0 -28
  25. data/lib/algolia/models/analytics/daily_conversion_rates.rb +0 -28
  26. data/lib/algolia/models/analytics/daily_no_click_rates.rb +0 -32
  27. data/lib/algolia/models/analytics/daily_no_results_rates.rb +0 -18
  28. data/lib/algolia/models/analytics/daily_purchase_rates.rb +0 -14
  29. data/lib/algolia/models/analytics/daily_searches_no_clicks.rb +0 -14
  30. data/lib/algolia/models/analytics/daily_searches_no_results.rb +0 -14
  31. data/lib/algolia/models/analytics/get_add_to_cart_rate_response.rb +0 -28
  32. data/lib/algolia/models/analytics/get_average_click_position_response.rb +0 -24
  33. data/lib/algolia/models/analytics/get_click_positions_response.rb +0 -18
  34. data/lib/algolia/models/analytics/get_click_through_rate_response.rb +0 -28
  35. data/lib/algolia/models/analytics/get_conversion_rate_response.rb +0 -28
  36. data/lib/algolia/models/analytics/get_no_click_rate_response.rb +0 -32
  37. data/lib/algolia/models/analytics/get_no_results_rate_response.rb +0 -18
  38. data/lib/algolia/models/analytics/get_purchase_rate_response.rb +0 -14
  39. data/lib/algolia/models/analytics/top_hit_with_analytics.rb +0 -56
  40. data/lib/algolia/models/analytics/top_hit_with_revenue_analytics.rb +0 -98
  41. data/lib/algolia/models/analytics/top_search_with_analytics.rb +0 -90
  42. data/lib/algolia/models/analytics/top_search_with_revenue_analytics.rb +0 -132
  43. data/lib/algolia/models/ingestion/event.rb +1 -25
  44. data/lib/algolia/models/ingestion/pagination.rb +0 -60
  45. data/lib/algolia/models/ingestion/run.rb +0 -18
  46. data/lib/algolia/models/ingestion/source_csv.rb +0 -21
  47. data/lib/algolia/models/ingestion/task.rb +0 -18
  48. data/lib/algolia/models/ingestion/task_create.rb +0 -18
  49. data/lib/algolia/models/ingestion/task_create_v1.rb +0 -18
  50. data/lib/algolia/models/ingestion/task_update.rb +0 -18
  51. data/lib/algolia/models/ingestion/task_update_v1.rb +0 -18
  52. data/lib/algolia/models/ingestion/task_v1.rb +0 -18
  53. data/lib/algolia/models/ingestion/transformation.rb +1 -1
  54. data/lib/algolia/models/ingestion/transformation_create.rb +1 -1
  55. data/lib/algolia/models/insights/added_to_cart_object_ids.rb +0 -123
  56. data/lib/algolia/models/insights/added_to_cart_object_ids_after_search.rb +0 -149
  57. data/lib/algolia/models/insights/clicked_filters.rb +0 -105
  58. data/lib/algolia/models/insights/clicked_object_ids.rb +0 -105
  59. data/lib/algolia/models/insights/clicked_object_ids_after_search.rb +0 -149
  60. data/lib/algolia/models/insights/converted_filters.rb +0 -105
  61. data/lib/algolia/models/insights/converted_object_ids.rb +0 -105
  62. data/lib/algolia/models/insights/converted_object_ids_after_search.rb +0 -131
  63. data/lib/algolia/models/insights/insights_events.rb +0 -18
  64. data/lib/algolia/models/insights/object_data_after_search.rb +0 -26
  65. data/lib/algolia/models/insights/purchased_object_ids.rb +0 -123
  66. data/lib/algolia/models/insights/purchased_object_ids_after_search.rb +0 -123
  67. data/lib/algolia/models/insights/viewed_filters.rb +0 -105
  68. data/lib/algolia/models/insights/viewed_object_ids.rb +0 -105
  69. data/lib/algolia/models/personalization/personalization_strategy_params.rb +0 -18
  70. data/lib/algolia/models/query-suggestions/configuration.rb +0 -17
  71. data/lib/algolia/models/query-suggestions/configuration_response.rb +0 -17
  72. data/lib/algolia/models/query-suggestions/configuration_with_index.rb +0 -17
  73. data/lib/algolia/models/query-suggestions/source_index.rb +0 -28
  74. data/lib/algolia/models/recommend/banner_image.rb +4 -2
  75. data/lib/algolia/models/recommend/bought_together_query.rb +0 -36
  76. data/lib/algolia/models/recommend/condition.rb +0 -15
  77. data/lib/algolia/models/recommend/consequence.rb +0 -28
  78. data/lib/algolia/models/recommend/fallback_params.rb +3 -95
  79. data/lib/algolia/models/recommend/looking_similar_query.rb +0 -36
  80. data/lib/algolia/models/recommend/promote_consequence_object.rb +0 -14
  81. data/lib/algolia/models/recommend/ranking_info.rb +0 -112
  82. data/lib/algolia/models/recommend/recommend_hit.rb +0 -20
  83. data/lib/algolia/models/recommend/recommend_search_params.rb +3 -95
  84. data/lib/algolia/models/recommend/recommendations_results.rb +13 -61
  85. data/lib/algolia/models/recommend/recommended_for_you_query.rb +0 -36
  86. data/lib/algolia/models/recommend/related_query.rb +0 -36
  87. data/lib/algolia/models/recommend/search_recommend_rules_params.rb +2 -52
  88. data/lib/algolia/models/recommend/search_recommend_rules_response.rb +0 -14
  89. data/lib/algolia/models/recommend/trending_facet_hit.rb +0 -20
  90. data/lib/algolia/models/recommend/trending_facets_query.rb +0 -36
  91. data/lib/algolia/models/recommend/trending_items_query.rb +0 -36
  92. data/lib/algolia/models/recommend/widgets.rb +5 -2
  93. data/lib/algolia/models/search/banner_image.rb +4 -2
  94. data/lib/algolia/models/search/browse_params_object.rb +1 -129
  95. data/lib/algolia/models/search/browse_response.rb +13 -61
  96. data/lib/algolia/models/search/condition.rb +0 -15
  97. data/lib/algolia/models/search/consequence.rb +0 -28
  98. data/lib/algolia/models/search/consequence_params.rb +1 -129
  99. data/lib/algolia/models/search/get_api_key_response.rb +2 -0
  100. data/lib/algolia/models/search/get_objects_response.rb +0 -2
  101. data/lib/algolia/models/search/index_settings.rb +3 -81
  102. data/lib/algolia/models/search/log.rb +0 -34
  103. data/lib/algolia/models/search/promote_object_ids.rb +0 -14
  104. data/lib/algolia/models/search/ranking_info.rb +0 -112
  105. data/lib/algolia/models/search/rule.rb +0 -18
  106. data/lib/algolia/models/search/search_dictionary_entries_params.rb +0 -32
  107. data/lib/algolia/models/search/search_dictionary_entries_response.rb +1 -15
  108. data/lib/algolia/models/search/search_for_facet_values_request.rb +0 -14
  109. data/lib/algolia/models/search/search_for_facets.rb +1 -129
  110. data/lib/algolia/models/search/search_for_hits.rb +1 -129
  111. data/lib/algolia/models/search/search_params_object.rb +1 -129
  112. data/lib/algolia/models/search/search_response.rb +13 -61
  113. data/lib/algolia/models/search/search_rules_params.rb +2 -34
  114. data/lib/algolia/models/search/search_synonyms_params.rb +0 -32
  115. data/lib/algolia/models/search/search_user_ids_params.rb +0 -32
  116. data/lib/algolia/models/search/search_user_ids_response.rb +1 -33
  117. data/lib/algolia/models/search/settings_response.rb +3 -81
  118. data/lib/algolia/models/search/user_hit.rb +0 -15
  119. data/lib/algolia/models/search/user_id.rb +0 -15
  120. data/lib/algolia/models/search/widgets.rb +5 -2
  121. data/lib/algolia/user_agent.rb +8 -2
  122. data/lib/algolia/version.rb +1 -1
  123. metadata +2 -11
  124. data/lib/algolia/models/query-suggestions/base_query_suggestions_configuration_response.rb +0 -230
  125. data/lib/algolia/models/query-suggestions/base_query_suggestions_configuration_with_index.rb +0 -212
  126. data/lib/algolia/models/query-suggestions/get_config_status200_response.rb +0 -252
  127. data/lib/algolia/models/query-suggestions/get_log_file200_response.rb +0 -263
  128. data/lib/algolia/models/query-suggestions/query_suggestions_configuration.rb +0 -276
  129. data/lib/algolia/models/query-suggestions/query_suggestions_configuration_response.rb +0 -316
  130. data/lib/algolia/models/query-suggestions/query_suggestions_configuration_with_index.rb +0 -295
  131. data/lib/algolia/models/recommend/banners.rb +0 -209
  132. data/lib/algolia/models/search/banners.rb +0 -209
@@ -45,11 +45,19 @@ module Algolia
45
45
  # @return [void]
46
46
  def set_client_api_key(api_key)
47
47
  @api_client.set_client_api_key(api_key)
48
+
49
+ self
50
+ end
51
+
52
+ def add_user_agent_segment(segment, version = nil)
53
+ @api_client.config.add_user_agent_segment(segment, version)
54
+
55
+ self
48
56
  end
49
57
 
50
58
  # This method allow you to send requests to the Algolia REST API.
51
59
 
52
- # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
60
+ # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
53
61
  # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
54
62
  # @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)
55
63
  # @return [Http::Response] the response
@@ -81,7 +89,7 @@ module Algolia
81
89
 
82
90
  # This method allow you to send requests to the Algolia REST API.
83
91
 
84
- # @param path [String] Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
92
+ # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
85
93
  # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
86
94
  # @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)
87
95
  # @return [Object]
@@ -92,7 +100,7 @@ module Algolia
92
100
 
93
101
  # This method allow you to send requests to the Algolia REST API.
94
102
 
95
- # @param path [String] Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
103
+ # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
96
104
  # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
97
105
  # @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)
98
106
  # @return [Http::Response] the response
@@ -124,7 +132,7 @@ module Algolia
124
132
 
125
133
  # This method allow you to send requests to the Algolia REST API.
126
134
 
127
- # @param path [String] Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
135
+ # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
128
136
  # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
129
137
  # @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)
130
138
  # @return [Object]
@@ -135,7 +143,7 @@ module Algolia
135
143
 
136
144
  # This method allow you to send requests to the Algolia REST API.
137
145
 
138
- # @param path [String] Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
146
+ # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
139
147
  # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
140
148
  # @param body [Object] Parameters to send with the custom request.
141
149
  # @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)
@@ -168,7 +176,7 @@ module Algolia
168
176
 
169
177
  # This method allow you to send requests to the Algolia REST API.
170
178
 
171
- # @param path [String] Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
179
+ # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
172
180
  # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
173
181
  # @param body [Object] Parameters to send with the custom request.
174
182
  # @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)
@@ -180,7 +188,7 @@ module Algolia
180
188
 
181
189
  # This method allow you to send requests to the Algolia REST API.
182
190
 
183
- # @param path [String] Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
191
+ # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
184
192
  # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
185
193
  # @param body [Object] Parameters to send with the custom request.
186
194
  # @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)
@@ -213,7 +221,7 @@ module Algolia
213
221
 
214
222
  # This method allow you to send requests to the Algolia REST API.
215
223
 
216
- # @param path [String] Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
224
+ # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
217
225
  # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
218
226
  # @param body [Object] Parameters to send with the custom request.
219
227
  # @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)
@@ -228,9 +236,9 @@ module Algolia
228
236
  # Required API Key ACLs:
229
237
  # - analytics
230
238
  # @param index [String] Index name. (required)
231
- # @param start_date [String] Start date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
232
- # @param end_date [String] End date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
233
- # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with &#x60;OR&#x60; and &#x60;AND&#x60;. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
239
+ # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
240
+ # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
241
+ # @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/).
234
242
  # @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)
235
243
  # @return [Http::Response] the response
236
244
  def get_add_to_cart_rate_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
@@ -267,9 +275,9 @@ module Algolia
267
275
  # Required API Key ACLs:
268
276
  # - analytics
269
277
  # @param index [String] Index name. (required)
270
- # @param start_date [String] Start date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
271
- # @param end_date [String] End date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
272
- # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with &#x60;OR&#x60; and &#x60;AND&#x60;. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
278
+ # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
279
+ # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
280
+ # @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/).
273
281
  # @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)
274
282
  # @return [GetAddToCartRateResponse]
275
283
  def get_add_to_cart_rate(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
@@ -280,14 +288,14 @@ module Algolia
280
288
  )
281
289
  end
282
290
 
283
- # 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&#39; 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.
291
+ # 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.
284
292
  #
285
293
  # Required API Key ACLs:
286
294
  # - analytics
287
295
  # @param index [String] Index name. (required)
288
- # @param start_date [String] Start date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
289
- # @param end_date [String] End date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
290
- # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with &#x60;OR&#x60; and &#x60;AND&#x60;. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
296
+ # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
297
+ # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
298
+ # @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/).
291
299
  # @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)
292
300
  # @return [Http::Response] the response
293
301
  def get_average_click_position_with_http_info(
@@ -330,9 +338,9 @@ module Algolia
330
338
  # Required API Key ACLs:
331
339
  # - analytics
332
340
  # @param index [String] Index name. (required)
333
- # @param start_date [String] Start date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
334
- # @param end_date [String] End date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
335
- # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with &#x60;OR&#x60; and &#x60;AND&#x60;. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
341
+ # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
342
+ # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
343
+ # @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/).
336
344
  # @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)
337
345
  # @return [GetAverageClickPositionResponse]
338
346
  def get_average_click_position(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
@@ -348,9 +356,9 @@ module Algolia
348
356
  # Required API Key ACLs:
349
357
  # - analytics
350
358
  # @param index [String] Index name. (required)
351
- # @param start_date [String] Start date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
352
- # @param end_date [String] End date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
353
- # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with &#x60;OR&#x60; and &#x60;AND&#x60;. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
359
+ # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
360
+ # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
361
+ # @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/).
354
362
  # @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)
355
363
  # @return [Http::Response] the response
356
364
  def get_click_positions_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
@@ -387,9 +395,9 @@ module Algolia
387
395
  # Required API Key ACLs:
388
396
  # - analytics
389
397
  # @param index [String] Index name. (required)
390
- # @param start_date [String] Start date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
391
- # @param end_date [String] End date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
392
- # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with &#x60;OR&#x60; and &#x60;AND&#x60;. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
398
+ # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
399
+ # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
400
+ # @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/).
393
401
  # @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)
394
402
  # @return [GetClickPositionsResponse]
395
403
  def get_click_positions(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
@@ -405,9 +413,9 @@ module Algolia
405
413
  # Required API Key ACLs:
406
414
  # - analytics
407
415
  # @param index [String] Index name. (required)
408
- # @param start_date [String] Start date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
409
- # @param end_date [String] End date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
410
- # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with &#x60;OR&#x60; and &#x60;AND&#x60;. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
416
+ # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
417
+ # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
418
+ # @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/).
411
419
  # @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)
412
420
  # @return [Http::Response] the response
413
421
  def get_click_through_rate_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
@@ -444,9 +452,9 @@ module Algolia
444
452
  # Required API Key ACLs:
445
453
  # - analytics
446
454
  # @param index [String] Index name. (required)
447
- # @param start_date [String] Start date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
448
- # @param end_date [String] End date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
449
- # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with &#x60;OR&#x60; and &#x60;AND&#x60;. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
455
+ # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
456
+ # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
457
+ # @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/).
450
458
  # @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)
451
459
  # @return [GetClickThroughRateResponse]
452
460
  def get_click_through_rate(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
@@ -462,9 +470,9 @@ module Algolia
462
470
  # Required API Key ACLs:
463
471
  # - analytics
464
472
  # @param index [String] Index name. (required)
465
- # @param start_date [String] Start date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
466
- # @param end_date [String] End date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
467
- # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with &#x60;OR&#x60; and &#x60;AND&#x60;. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
473
+ # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
474
+ # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
475
+ # @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/).
468
476
  # @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)
469
477
  # @return [Http::Response] the response
470
478
  def get_conversion_rate_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
@@ -501,9 +509,9 @@ module Algolia
501
509
  # Required API Key ACLs:
502
510
  # - analytics
503
511
  # @param index [String] Index name. (required)
504
- # @param start_date [String] Start date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
505
- # @param end_date [String] End date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
506
- # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with &#x60;OR&#x60; and &#x60;AND&#x60;. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
512
+ # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
513
+ # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
514
+ # @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/).
507
515
  # @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)
508
516
  # @return [GetConversionRateResponse]
509
517
  def get_conversion_rate(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
@@ -514,14 +522,14 @@ module Algolia
514
522
  )
515
523
  end
516
524
 
517
- # Retrieves the fraction of searches that didn&#39;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.
525
+ # 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.
518
526
  #
519
527
  # Required API Key ACLs:
520
528
  # - analytics
521
529
  # @param index [String] Index name. (required)
522
- # @param start_date [String] Start date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
523
- # @param end_date [String] End date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
524
- # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with &#x60;OR&#x60; and &#x60;AND&#x60;. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
530
+ # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
531
+ # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
532
+ # @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/).
525
533
  # @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)
526
534
  # @return [Http::Response] the response
527
535
  def get_no_click_rate_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
@@ -558,9 +566,9 @@ module Algolia
558
566
  # Required API Key ACLs:
559
567
  # - analytics
560
568
  # @param index [String] Index name. (required)
561
- # @param start_date [String] Start date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
562
- # @param end_date [String] End date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
563
- # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with &#x60;OR&#x60; and &#x60;AND&#x60;. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
569
+ # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
570
+ # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
571
+ # @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/).
564
572
  # @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)
565
573
  # @return [GetNoClickRateResponse]
566
574
  def get_no_click_rate(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
@@ -568,14 +576,14 @@ module Algolia
568
576
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Analytics::GetNoClickRateResponse")
569
577
  end
570
578
 
571
- # Retrieves the fraction of searches that didn&#39;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.
579
+ # 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.
572
580
  #
573
581
  # Required API Key ACLs:
574
582
  # - analytics
575
583
  # @param index [String] Index name. (required)
576
- # @param start_date [String] Start date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
577
- # @param end_date [String] End date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
578
- # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with &#x60;OR&#x60; and &#x60;AND&#x60;. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
584
+ # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
585
+ # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
586
+ # @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/).
579
587
  # @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)
580
588
  # @return [Http::Response] the response
581
589
  def get_no_results_rate_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
@@ -612,9 +620,9 @@ module Algolia
612
620
  # Required API Key ACLs:
613
621
  # - analytics
614
622
  # @param index [String] Index name. (required)
615
- # @param start_date [String] Start date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
616
- # @param end_date [String] End date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
617
- # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with &#x60;OR&#x60; and &#x60;AND&#x60;. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
623
+ # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
624
+ # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
625
+ # @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/).
618
626
  # @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)
619
627
  # @return [GetNoResultsRateResponse]
620
628
  def get_no_results_rate(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
@@ -630,9 +638,9 @@ module Algolia
630
638
  # Required API Key ACLs:
631
639
  # - analytics
632
640
  # @param index [String] Index name. (required)
633
- # @param start_date [String] Start date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
634
- # @param end_date [String] End date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
635
- # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with &#x60;OR&#x60; and &#x60;AND&#x60;. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
641
+ # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
642
+ # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
643
+ # @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/).
636
644
  # @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)
637
645
  # @return [Http::Response] the response
638
646
  def get_purchase_rate_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
@@ -669,9 +677,9 @@ module Algolia
669
677
  # Required API Key ACLs:
670
678
  # - analytics
671
679
  # @param index [String] Index name. (required)
672
- # @param start_date [String] Start date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
673
- # @param end_date [String] End date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
674
- # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with &#x60;OR&#x60; and &#x60;AND&#x60;. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
680
+ # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
681
+ # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
682
+ # @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/).
675
683
  # @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)
676
684
  # @return [GetPurchaseRateResponse]
677
685
  def get_purchase_rate(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
@@ -687,9 +695,9 @@ module Algolia
687
695
  # Required API Key ACLs:
688
696
  # - analytics
689
697
  # @param index [String] Index name. (required)
690
- # @param start_date [String] Start date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
691
- # @param end_date [String] End date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
692
- # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with &#x60;OR&#x60; and &#x60;AND&#x60;. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
698
+ # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
699
+ # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
700
+ # @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/).
693
701
  # @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)
694
702
  # @return [Http::Response] the response
695
703
  def get_revenue_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
@@ -726,9 +734,9 @@ module Algolia
726
734
  # Required API Key ACLs:
727
735
  # - analytics
728
736
  # @param index [String] Index name. (required)
729
- # @param start_date [String] Start date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
730
- # @param end_date [String] End date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
731
- # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with &#x60;OR&#x60; and &#x60;AND&#x60;. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
737
+ # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
738
+ # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
739
+ # @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/).
732
740
  # @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)
733
741
  # @return [GetRevenue]
734
742
  def get_revenue(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
@@ -741,9 +749,9 @@ module Algolia
741
749
  # Required API Key ACLs:
742
750
  # - analytics
743
751
  # @param index [String] Index name. (required)
744
- # @param start_date [String] Start date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
745
- # @param end_date [String] End date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
746
- # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with &#x60;OR&#x60; and &#x60;AND&#x60;. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
752
+ # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
753
+ # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
754
+ # @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/).
747
755
  # @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)
748
756
  # @return [Http::Response] the response
749
757
  def get_searches_count_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
@@ -780,9 +788,9 @@ module Algolia
780
788
  # Required API Key ACLs:
781
789
  # - analytics
782
790
  # @param index [String] Index name. (required)
783
- # @param start_date [String] Start date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
784
- # @param end_date [String] End date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
785
- # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with &#x60;OR&#x60; and &#x60;AND&#x60;. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
791
+ # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
792
+ # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
793
+ # @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/).
786
794
  # @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)
787
795
  # @return [GetSearchesCountResponse]
788
796
  def get_searches_count(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
@@ -793,16 +801,16 @@ module Algolia
793
801
  )
794
802
  end
795
803
 
796
- # Retrieves the most popular searches that didn&#39;t lead to any clicks, from the 1,000 most frequent searches.
804
+ # Retrieves the most popular searches that didn't lead to any clicks, from the 1,000 most frequent searches.
797
805
  #
798
806
  # Required API Key ACLs:
799
807
  # - analytics
800
808
  # @param index [String] Index name. (required)
801
- # @param start_date [String] Start date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
802
- # @param end_date [String] End date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
803
- # @param limit [Integer] Number of items to return. Combined with the &#x60;offset&#x60; parameter, only the first 1000 items can be retrieved. (default to 10)
804
- # @param offset [Integer] Position of the first item to return. Combined with the &#x60;limit&#x60; parameter, only the first 1000 items can be retrieved. (default to 0)
805
- # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with &#x60;OR&#x60; and &#x60;AND&#x60;. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
809
+ # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
810
+ # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
811
+ # @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10)
812
+ # @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)
813
+ # @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/).
806
814
  # @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)
807
815
  # @return [Http::Response] the response
808
816
  def get_searches_no_clicks_with_http_info(
@@ -819,27 +827,6 @@ module Algolia
819
827
  raise ArgumentError, "Parameter `index` is required when calling `get_searches_no_clicks`."
820
828
  end
821
829
 
822
- if @api_client.config.client_side_validation && !limit.nil? && limit > 1000
823
- raise(
824
- ArgumentError,
825
- "invalid value for \"\"limit\"\" when calling AnalyticsClient.get_searches_no_clicks, must be smaller than or equal to 1000."
826
- )
827
- end
828
-
829
- if @api_client.config.client_side_validation && !offset.nil? && offset > 1000
830
- raise(
831
- ArgumentError,
832
- "invalid value for \"\"offset\"\" when calling AnalyticsClient.get_searches_no_clicks, must be smaller than or equal to 1000."
833
- )
834
- end
835
-
836
- if @api_client.config.client_side_validation && !offset.nil? && offset < 0
837
- raise(
838
- ArgumentError,
839
- "invalid value for \"\"offset\"\" when calling AnalyticsClient.get_searches_no_clicks, must be greater than or equal to 0."
840
- )
841
- end
842
-
843
830
  path = "/2/searches/noClicks"
844
831
  query_params = {}
845
832
  query_params[:index] = index
@@ -870,11 +857,11 @@ module Algolia
870
857
  # Required API Key ACLs:
871
858
  # - analytics
872
859
  # @param index [String] Index name. (required)
873
- # @param start_date [String] Start date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
874
- # @param end_date [String] End date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
875
- # @param limit [Integer] Number of items to return. Combined with the &#x60;offset&#x60; parameter, only the first 1000 items can be retrieved. (default to 10)
876
- # @param offset [Integer] Position of the first item to return. Combined with the &#x60;limit&#x60; parameter, only the first 1000 items can be retrieved. (default to 0)
877
- # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with &#x60;OR&#x60; and &#x60;AND&#x60;. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
860
+ # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
861
+ # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
862
+ # @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10)
863
+ # @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)
864
+ # @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/).
878
865
  # @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)
879
866
  # @return [GetSearchesNoClicksResponse]
880
867
  def get_searches_no_clicks(
@@ -901,16 +888,16 @@ module Algolia
901
888
  )
902
889
  end
903
890
 
904
- # Retrieves the most popular searches that didn&#39;t return any results.
891
+ # Retrieves the most popular searches that didn't return any results.
905
892
  #
906
893
  # Required API Key ACLs:
907
894
  # - analytics
908
895
  # @param index [String] Index name. (required)
909
- # @param start_date [String] Start date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
910
- # @param end_date [String] End date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
911
- # @param limit [Integer] Number of items to return. Combined with the &#x60;offset&#x60; parameter, only the first 1000 items can be retrieved. (default to 10)
912
- # @param offset [Integer] Position of the first item to return. Combined with the &#x60;limit&#x60; parameter, only the first 1000 items can be retrieved. (default to 0)
913
- # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with &#x60;OR&#x60; and &#x60;AND&#x60;. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
896
+ # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
897
+ # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
898
+ # @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10)
899
+ # @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)
900
+ # @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/).
914
901
  # @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)
915
902
  # @return [Http::Response] the response
916
903
  def get_searches_no_results_with_http_info(
@@ -927,27 +914,6 @@ module Algolia
927
914
  raise ArgumentError, "Parameter `index` is required when calling `get_searches_no_results`."
928
915
  end
929
916
 
930
- if @api_client.config.client_side_validation && !limit.nil? && limit > 1000
931
- raise(
932
- ArgumentError,
933
- "invalid value for \"\"limit\"\" when calling AnalyticsClient.get_searches_no_results, must be smaller than or equal to 1000."
934
- )
935
- end
936
-
937
- if @api_client.config.client_side_validation && !offset.nil? && offset > 1000
938
- raise(
939
- ArgumentError,
940
- "invalid value for \"\"offset\"\" when calling AnalyticsClient.get_searches_no_results, must be smaller than or equal to 1000."
941
- )
942
- end
943
-
944
- if @api_client.config.client_side_validation && !offset.nil? && offset < 0
945
- raise(
946
- ArgumentError,
947
- "invalid value for \"\"offset\"\" when calling AnalyticsClient.get_searches_no_results, must be greater than or equal to 0."
948
- )
949
- end
950
-
951
917
  path = "/2/searches/noResults"
952
918
  query_params = {}
953
919
  query_params[:index] = index
@@ -978,11 +944,11 @@ module Algolia
978
944
  # Required API Key ACLs:
979
945
  # - analytics
980
946
  # @param index [String] Index name. (required)
981
- # @param start_date [String] Start date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
982
- # @param end_date [String] End date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
983
- # @param limit [Integer] Number of items to return. Combined with the &#x60;offset&#x60; parameter, only the first 1000 items can be retrieved. (default to 10)
984
- # @param offset [Integer] Position of the first item to return. Combined with the &#x60;limit&#x60; parameter, only the first 1000 items can be retrieved. (default to 0)
985
- # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with &#x60;OR&#x60; and &#x60;AND&#x60;. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
947
+ # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
948
+ # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
949
+ # @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10)
950
+ # @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)
951
+ # @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/).
986
952
  # @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)
987
953
  # @return [GetSearchesNoResultsResponse]
988
954
  def get_searches_no_results(
@@ -1059,11 +1025,11 @@ module Algolia
1059
1025
  # Required API Key ACLs:
1060
1026
  # - analytics
1061
1027
  # @param index [String] Index name. (required)
1062
- # @param start_date [String] Start date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
1063
- # @param end_date [String] End date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
1064
- # @param limit [Integer] Number of items to return. Combined with the &#x60;offset&#x60; parameter, only the first 1000 items can be retrieved. (default to 10)
1065
- # @param offset [Integer] Position of the first item to return. Combined with the &#x60;limit&#x60; parameter, only the first 1000 items can be retrieved. (default to 0)
1066
- # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with &#x60;OR&#x60; and &#x60;AND&#x60;. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
1028
+ # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
1029
+ # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
1030
+ # @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10)
1031
+ # @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)
1032
+ # @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/).
1067
1033
  # @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)
1068
1034
  # @return [Http::Response] the response
1069
1035
  def get_top_countries_with_http_info(
@@ -1080,27 +1046,6 @@ module Algolia
1080
1046
  raise ArgumentError, "Parameter `index` is required when calling `get_top_countries`."
1081
1047
  end
1082
1048
 
1083
- if @api_client.config.client_side_validation && !limit.nil? && limit > 1000
1084
- raise(
1085
- ArgumentError,
1086
- "invalid value for \"\"limit\"\" when calling AnalyticsClient.get_top_countries, must be smaller than or equal to 1000."
1087
- )
1088
- end
1089
-
1090
- if @api_client.config.client_side_validation && !offset.nil? && offset > 1000
1091
- raise(
1092
- ArgumentError,
1093
- "invalid value for \"\"offset\"\" when calling AnalyticsClient.get_top_countries, must be smaller than or equal to 1000."
1094
- )
1095
- end
1096
-
1097
- if @api_client.config.client_side_validation && !offset.nil? && offset < 0
1098
- raise(
1099
- ArgumentError,
1100
- "invalid value for \"\"offset\"\" when calling AnalyticsClient.get_top_countries, must be greater than or equal to 0."
1101
- )
1102
- end
1103
-
1104
1049
  path = "/2/countries"
1105
1050
  query_params = {}
1106
1051
  query_params[:index] = index
@@ -1131,11 +1076,11 @@ module Algolia
1131
1076
  # Required API Key ACLs:
1132
1077
  # - analytics
1133
1078
  # @param index [String] Index name. (required)
1134
- # @param start_date [String] Start date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
1135
- # @param end_date [String] End date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
1136
- # @param limit [Integer] Number of items to return. Combined with the &#x60;offset&#x60; parameter, only the first 1000 items can be retrieved. (default to 10)
1137
- # @param offset [Integer] Position of the first item to return. Combined with the &#x60;limit&#x60; parameter, only the first 1000 items can be retrieved. (default to 0)
1138
- # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with &#x60;OR&#x60; and &#x60;AND&#x60;. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
1079
+ # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
1080
+ # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
1081
+ # @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10)
1082
+ # @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)
1083
+ # @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/).
1139
1084
  # @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)
1140
1085
  # @return [GetTopCountriesResponse]
1141
1086
  def get_top_countries(
@@ -1154,17 +1099,17 @@ module Algolia
1154
1099
  )
1155
1100
  end
1156
1101
 
1157
- # Retrieves the most frequently used filter attributes. These are attributes of your records that you included in the &#x60;attributesForFaceting&#x60; setting.
1102
+ # Retrieves the most frequently used filter attributes. These are attributes of your records that you included in the `attributesForFaceting` setting.
1158
1103
  #
1159
1104
  # Required API Key ACLs:
1160
1105
  # - analytics
1161
1106
  # @param index [String] Index name. (required)
1162
1107
  # @param search [String] Search query.
1163
- # @param start_date [String] Start date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
1164
- # @param end_date [String] End date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
1165
- # @param limit [Integer] Number of items to return. Combined with the &#x60;offset&#x60; parameter, only the first 1000 items can be retrieved. (default to 10)
1166
- # @param offset [Integer] Position of the first item to return. Combined with the &#x60;limit&#x60; parameter, only the first 1000 items can be retrieved. (default to 0)
1167
- # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with &#x60;OR&#x60; and &#x60;AND&#x60;. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
1108
+ # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
1109
+ # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
1110
+ # @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10)
1111
+ # @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)
1112
+ # @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/).
1168
1113
  # @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)
1169
1114
  # @return [Http::Response] the response
1170
1115
  def get_top_filter_attributes_with_http_info(
@@ -1182,27 +1127,6 @@ module Algolia
1182
1127
  raise ArgumentError, "Parameter `index` is required when calling `get_top_filter_attributes`."
1183
1128
  end
1184
1129
 
1185
- if @api_client.config.client_side_validation && !limit.nil? && limit > 1000
1186
- raise(
1187
- ArgumentError,
1188
- "invalid value for \"\"limit\"\" when calling AnalyticsClient.get_top_filter_attributes, must be smaller than or equal to 1000."
1189
- )
1190
- end
1191
-
1192
- if @api_client.config.client_side_validation && !offset.nil? && offset > 1000
1193
- raise(
1194
- ArgumentError,
1195
- "invalid value for \"\"offset\"\" when calling AnalyticsClient.get_top_filter_attributes, must be smaller than or equal to 1000."
1196
- )
1197
- end
1198
-
1199
- if @api_client.config.client_side_validation && !offset.nil? && offset < 0
1200
- raise(
1201
- ArgumentError,
1202
- "invalid value for \"\"offset\"\" when calling AnalyticsClient.get_top_filter_attributes, must be greater than or equal to 0."
1203
- )
1204
- end
1205
-
1206
1130
  path = "/2/filters"
1207
1131
  query_params = {}
1208
1132
  query_params[:index] = index
@@ -1235,11 +1159,11 @@ module Algolia
1235
1159
  # - analytics
1236
1160
  # @param index [String] Index name. (required)
1237
1161
  # @param search [String] Search query.
1238
- # @param start_date [String] Start date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
1239
- # @param end_date [String] End date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
1240
- # @param limit [Integer] Number of items to return. Combined with the &#x60;offset&#x60; parameter, only the first 1000 items can be retrieved. (default to 10)
1241
- # @param offset [Integer] Position of the first item to return. Combined with the &#x60;limit&#x60; parameter, only the first 1000 items can be retrieved. (default to 0)
1242
- # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with &#x60;OR&#x60; and &#x60;AND&#x60;. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
1162
+ # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
1163
+ # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
1164
+ # @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10)
1165
+ # @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)
1166
+ # @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/).
1243
1167
  # @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)
1244
1168
  # @return [GetTopFilterAttributesResponse]
1245
1169
  def get_top_filter_attributes(
@@ -1268,18 +1192,18 @@ module Algolia
1268
1192
  )
1269
1193
  end
1270
1194
 
1271
- # Retrieves the most frequent filter (facet) values for a filter attribute. These are attributes of your records that you included in the &#x60;attributesForFaceting&#x60; setting.
1195
+ # Retrieves the most frequent filter (facet) values for a filter attribute. These are attributes of your records that you included in the `attributesForFaceting` setting.
1272
1196
  #
1273
1197
  # Required API Key ACLs:
1274
1198
  # - analytics
1275
1199
  # @param attribute [String] Attribute name. (required)
1276
1200
  # @param index [String] Index name. (required)
1277
1201
  # @param search [String] Search query.
1278
- # @param start_date [String] Start date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
1279
- # @param end_date [String] End date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
1280
- # @param limit [Integer] Number of items to return. Combined with the &#x60;offset&#x60; parameter, only the first 1000 items can be retrieved. (default to 10)
1281
- # @param offset [Integer] Position of the first item to return. Combined with the &#x60;limit&#x60; parameter, only the first 1000 items can be retrieved. (default to 0)
1282
- # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with &#x60;OR&#x60; and &#x60;AND&#x60;. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
1202
+ # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
1203
+ # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
1204
+ # @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10)
1205
+ # @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)
1206
+ # @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/).
1283
1207
  # @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)
1284
1208
  # @return [Http::Response] the response
1285
1209
  def get_top_filter_for_attribute_with_http_info(
@@ -1302,27 +1226,6 @@ module Algolia
1302
1226
  raise ArgumentError, "Parameter `index` is required when calling `get_top_filter_for_attribute`."
1303
1227
  end
1304
1228
 
1305
- if @api_client.config.client_side_validation && !limit.nil? && limit > 1000
1306
- raise(
1307
- ArgumentError,
1308
- "invalid value for \"\"limit\"\" when calling AnalyticsClient.get_top_filter_for_attribute, must be smaller than or equal to 1000."
1309
- )
1310
- end
1311
-
1312
- if @api_client.config.client_side_validation && !offset.nil? && offset > 1000
1313
- raise(
1314
- ArgumentError,
1315
- "invalid value for \"\"offset\"\" when calling AnalyticsClient.get_top_filter_for_attribute, must be smaller than or equal to 1000."
1316
- )
1317
- end
1318
-
1319
- if @api_client.config.client_side_validation && !offset.nil? && offset < 0
1320
- raise(
1321
- ArgumentError,
1322
- "invalid value for \"\"offset\"\" when calling AnalyticsClient.get_top_filter_for_attribute, must be greater than or equal to 0."
1323
- )
1324
- end
1325
-
1326
1229
  path = "/2/filters/{attribute}".sub("{" + "attribute" + "}", Transport.encode_uri(attribute.to_s))
1327
1230
  query_params = {}
1328
1231
  query_params[:index] = index
@@ -1356,11 +1259,11 @@ module Algolia
1356
1259
  # @param attribute [String] Attribute name. (required)
1357
1260
  # @param index [String] Index name. (required)
1358
1261
  # @param search [String] Search query.
1359
- # @param start_date [String] Start date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
1360
- # @param end_date [String] End date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
1361
- # @param limit [Integer] Number of items to return. Combined with the &#x60;offset&#x60; parameter, only the first 1000 items can be retrieved. (default to 10)
1362
- # @param offset [Integer] Position of the first item to return. Combined with the &#x60;limit&#x60; parameter, only the first 1000 items can be retrieved. (default to 0)
1363
- # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with &#x60;OR&#x60; and &#x60;AND&#x60;. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
1262
+ # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
1263
+ # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
1264
+ # @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10)
1265
+ # @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)
1266
+ # @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/).
1364
1267
  # @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)
1365
1268
  # @return [GetTopFilterForAttributeResponse]
1366
1269
  def get_top_filter_for_attribute(
@@ -1391,17 +1294,17 @@ module Algolia
1391
1294
  )
1392
1295
  end
1393
1296
 
1394
- # Retrieves the most frequently used filters for a search that didn&#39;t return any results. To get the most frequent searches without results, use the [Retrieve searches without results](#tag/search/operation/getSearchesNoResults) operation.
1297
+ # Retrieves the 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](#tag/search/operation/getSearchesNoResults) operation.
1395
1298
  #
1396
1299
  # Required API Key ACLs:
1397
1300
  # - analytics
1398
1301
  # @param index [String] Index name. (required)
1399
1302
  # @param search [String] Search query.
1400
- # @param start_date [String] Start date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
1401
- # @param end_date [String] End date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
1402
- # @param limit [Integer] Number of items to return. Combined with the &#x60;offset&#x60; parameter, only the first 1000 items can be retrieved. (default to 10)
1403
- # @param offset [Integer] Position of the first item to return. Combined with the &#x60;limit&#x60; parameter, only the first 1000 items can be retrieved. (default to 0)
1404
- # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with &#x60;OR&#x60; and &#x60;AND&#x60;. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
1303
+ # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
1304
+ # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
1305
+ # @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10)
1306
+ # @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)
1307
+ # @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/).
1405
1308
  # @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)
1406
1309
  # @return [Http::Response] the response
1407
1310
  def get_top_filters_no_results_with_http_info(
@@ -1419,27 +1322,6 @@ module Algolia
1419
1322
  raise ArgumentError, "Parameter `index` is required when calling `get_top_filters_no_results`."
1420
1323
  end
1421
1324
 
1422
- if @api_client.config.client_side_validation && !limit.nil? && limit > 1000
1423
- raise(
1424
- ArgumentError,
1425
- "invalid value for \"\"limit\"\" when calling AnalyticsClient.get_top_filters_no_results, must be smaller than or equal to 1000."
1426
- )
1427
- end
1428
-
1429
- if @api_client.config.client_side_validation && !offset.nil? && offset > 1000
1430
- raise(
1431
- ArgumentError,
1432
- "invalid value for \"\"offset\"\" when calling AnalyticsClient.get_top_filters_no_results, must be smaller than or equal to 1000."
1433
- )
1434
- end
1435
-
1436
- if @api_client.config.client_side_validation && !offset.nil? && offset < 0
1437
- raise(
1438
- ArgumentError,
1439
- "invalid value for \"\"offset\"\" when calling AnalyticsClient.get_top_filters_no_results, must be greater than or equal to 0."
1440
- )
1441
- end
1442
-
1443
1325
  path = "/2/filters/noResults"
1444
1326
  query_params = {}
1445
1327
  query_params[:index] = index
@@ -1472,11 +1354,11 @@ module Algolia
1472
1354
  # - analytics
1473
1355
  # @param index [String] Index name. (required)
1474
1356
  # @param search [String] Search query.
1475
- # @param start_date [String] Start date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
1476
- # @param end_date [String] End date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
1477
- # @param limit [Integer] Number of items to return. Combined with the &#x60;offset&#x60; parameter, only the first 1000 items can be retrieved. (default to 10)
1478
- # @param offset [Integer] Position of the first item to return. Combined with the &#x60;limit&#x60; parameter, only the first 1000 items can be retrieved. (default to 0)
1479
- # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with &#x60;OR&#x60; and &#x60;AND&#x60;. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
1357
+ # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
1358
+ # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
1359
+ # @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10)
1360
+ # @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)
1361
+ # @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/).
1480
1362
  # @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)
1481
1363
  # @return [GetTopFiltersNoResultsResponse]
1482
1364
  def get_top_filters_no_results(
@@ -1513,11 +1395,11 @@ module Algolia
1513
1395
  # @param search [String] Search query.
1514
1396
  # @param click_analytics [Boolean] Whether to include metrics related to click and conversion events in the response. (default to false)
1515
1397
  # @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)
1516
- # @param start_date [String] Start date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
1517
- # @param end_date [String] End date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
1518
- # @param limit [Integer] Number of items to return. Combined with the &#x60;offset&#x60; parameter, only the first 1000 items can be retrieved. (default to 10)
1519
- # @param offset [Integer] Position of the first item to return. Combined with the &#x60;limit&#x60; parameter, only the first 1000 items can be retrieved. (default to 0)
1520
- # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with &#x60;OR&#x60; and &#x60;AND&#x60;. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
1398
+ # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
1399
+ # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
1400
+ # @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10)
1401
+ # @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)
1402
+ # @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/).
1521
1403
  # @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)
1522
1404
  # @return [Http::Response] the response
1523
1405
  def get_top_hits_with_http_info(
@@ -1537,27 +1419,6 @@ module Algolia
1537
1419
  raise ArgumentError, "Parameter `index` is required when calling `get_top_hits`."
1538
1420
  end
1539
1421
 
1540
- if @api_client.config.client_side_validation && !limit.nil? && limit > 1000
1541
- raise(
1542
- ArgumentError,
1543
- "invalid value for \"\"limit\"\" when calling AnalyticsClient.get_top_hits, must be smaller than or equal to 1000."
1544
- )
1545
- end
1546
-
1547
- if @api_client.config.client_side_validation && !offset.nil? && offset > 1000
1548
- raise(
1549
- ArgumentError,
1550
- "invalid value for \"\"offset\"\" when calling AnalyticsClient.get_top_hits, must be smaller than or equal to 1000."
1551
- )
1552
- end
1553
-
1554
- if @api_client.config.client_side_validation && !offset.nil? && offset < 0
1555
- raise(
1556
- ArgumentError,
1557
- "invalid value for \"\"offset\"\" when calling AnalyticsClient.get_top_hits, must be greater than or equal to 0."
1558
- )
1559
- end
1560
-
1561
1422
  path = "/2/hits"
1562
1423
  query_params = {}
1563
1424
  query_params[:index] = index
@@ -1594,11 +1455,11 @@ module Algolia
1594
1455
  # @param search [String] Search query.
1595
1456
  # @param click_analytics [Boolean] Whether to include metrics related to click and conversion events in the response. (default to false)
1596
1457
  # @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)
1597
- # @param start_date [String] Start date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
1598
- # @param end_date [String] End date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
1599
- # @param limit [Integer] Number of items to return. Combined with the &#x60;offset&#x60; parameter, only the first 1000 items can be retrieved. (default to 10)
1600
- # @param offset [Integer] Position of the first item to return. Combined with the &#x60;limit&#x60; parameter, only the first 1000 items can be retrieved. (default to 0)
1601
- # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with &#x60;OR&#x60; and &#x60;AND&#x60;. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
1458
+ # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
1459
+ # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
1460
+ # @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10)
1461
+ # @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)
1462
+ # @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/).
1602
1463
  # @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)
1603
1464
  # @return [GetTopHitsResponse]
1604
1465
  def get_top_hits(
@@ -1635,13 +1496,13 @@ module Algolia
1635
1496
  # @param index [String] Index name. (required)
1636
1497
  # @param click_analytics [Boolean] Whether to include metrics related to click and conversion events in the response. (default to false)
1637
1498
  # @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)
1638
- # @param start_date [String] Start date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
1639
- # @param end_date [String] End date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
1640
- # @param order_by [OrderBy] Attribute by which to order the response items. If the &#x60;clickAnalytics&#x60; parameter is false, only &#x60;searchCount&#x60; is available. (default to 'searchCount')
1499
+ # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
1500
+ # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
1501
+ # @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')
1641
1502
  # @param direction [Direction] Sorting direction of the results: ascending or descending. (default to 'asc')
1642
- # @param limit [Integer] Number of items to return. Combined with the &#x60;offset&#x60; parameter, only the first 1000 items can be retrieved. (default to 10)
1643
- # @param offset [Integer] Position of the first item to return. Combined with the &#x60;limit&#x60; parameter, only the first 1000 items can be retrieved. (default to 0)
1644
- # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with &#x60;OR&#x60; and &#x60;AND&#x60;. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
1503
+ # @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10)
1504
+ # @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)
1505
+ # @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/).
1645
1506
  # @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)
1646
1507
  # @return [Http::Response] the response
1647
1508
  def get_top_searches_with_http_info(
@@ -1662,27 +1523,6 @@ module Algolia
1662
1523
  raise ArgumentError, "Parameter `index` is required when calling `get_top_searches`."
1663
1524
  end
1664
1525
 
1665
- if @api_client.config.client_side_validation && !limit.nil? && limit > 1000
1666
- raise(
1667
- ArgumentError,
1668
- "invalid value for \"\"limit\"\" when calling AnalyticsClient.get_top_searches, must be smaller than or equal to 1000."
1669
- )
1670
- end
1671
-
1672
- if @api_client.config.client_side_validation && !offset.nil? && offset > 1000
1673
- raise(
1674
- ArgumentError,
1675
- "invalid value for \"\"offset\"\" when calling AnalyticsClient.get_top_searches, must be smaller than or equal to 1000."
1676
- )
1677
- end
1678
-
1679
- if @api_client.config.client_side_validation && !offset.nil? && offset < 0
1680
- raise(
1681
- ArgumentError,
1682
- "invalid value for \"\"offset\"\" when calling AnalyticsClient.get_top_searches, must be greater than or equal to 0."
1683
- )
1684
- end
1685
-
1686
1526
  path = "/2/searches"
1687
1527
  query_params = {}
1688
1528
  query_params[:index] = index
@@ -1719,13 +1559,13 @@ module Algolia
1719
1559
  # @param index [String] Index name. (required)
1720
1560
  # @param click_analytics [Boolean] Whether to include metrics related to click and conversion events in the response. (default to false)
1721
1561
  # @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)
1722
- # @param start_date [String] Start date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
1723
- # @param end_date [String] End date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
1724
- # @param order_by [OrderBy] Attribute by which to order the response items. If the &#x60;clickAnalytics&#x60; parameter is false, only &#x60;searchCount&#x60; is available. (default to 'searchCount')
1562
+ # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
1563
+ # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
1564
+ # @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')
1725
1565
  # @param direction [Direction] Sorting direction of the results: ascending or descending. (default to 'asc')
1726
- # @param limit [Integer] Number of items to return. Combined with the &#x60;offset&#x60; parameter, only the first 1000 items can be retrieved. (default to 10)
1727
- # @param offset [Integer] Position of the first item to return. Combined with the &#x60;limit&#x60; parameter, only the first 1000 items can be retrieved. (default to 0)
1728
- # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with &#x60;OR&#x60; and &#x60;AND&#x60;. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
1566
+ # @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10)
1567
+ # @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)
1568
+ # @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/).
1729
1569
  # @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)
1730
1570
  # @return [GetTopSearchesResponse]
1731
1571
  def get_top_searches(
@@ -1757,14 +1597,14 @@ module Algolia
1757
1597
  @api_client.deserialize(response.body, request_options[:debug_return_type] || "Analytics::GetTopSearchesResponse")
1758
1598
  end
1759
1599
 
1760
- # 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 &#x60;userToken&#x60; API parameter or &#x60;x-algolia-usertoken&#x60; request header. By default, the analyzed period includes the last eight days including the current day.
1600
+ # 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.
1761
1601
  #
1762
1602
  # Required API Key ACLs:
1763
1603
  # - analytics
1764
1604
  # @param index [String] Index name. (required)
1765
- # @param start_date [String] Start date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
1766
- # @param end_date [String] End date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
1767
- # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with &#x60;OR&#x60; and &#x60;AND&#x60;. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
1605
+ # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
1606
+ # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
1607
+ # @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/).
1768
1608
  # @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)
1769
1609
  # @return [Http::Response] the response
1770
1610
  def get_users_count_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
@@ -1801,9 +1641,9 @@ module Algolia
1801
1641
  # Required API Key ACLs:
1802
1642
  # - analytics
1803
1643
  # @param index [String] Index name. (required)
1804
- # @param start_date [String] Start date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
1805
- # @param end_date [String] End date of the period to analyze, in &#x60;YYYY-MM-DD&#x60; format.
1806
- # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with &#x60;OR&#x60; and &#x60;AND&#x60;. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
1644
+ # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
1645
+ # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
1646
+ # @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/).
1807
1647
  # @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)
1808
1648
  # @return [GetUsersCountResponse]
1809
1649
  def get_users_count(index, start_date = nil, end_date = nil, tags = nil, request_options = {})