algolia 3.5.1 → 3.5.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/Gemfile.lock +1 -1
- data/lib/algolia/api/abtesting_client.rb +17 -9
- data/lib/algolia/api/analytics_client.rb +173 -165
- data/lib/algolia/api/ingestion_client.rb +38 -30
- data/lib/algolia/api/insights_client.rb +18 -10
- data/lib/algolia/api/monitoring_client.rb +22 -14
- data/lib/algolia/api/personalization_client.rb +16 -8
- data/lib/algolia/api/query_suggestions_client.rb +17 -9
- data/lib/algolia/api/recommend_client.rb +17 -9
- data/lib/algolia/api/search_client.rb +60 -52
- data/lib/algolia/configuration.rb +16 -1
- data/lib/algolia/models/abtesting/ab_test_configuration.rb +0 -2
- data/lib/algolia/models/abtesting/variant.rb +0 -2
- data/lib/algolia/models/ingestion/event.rb +1 -11
- data/lib/algolia/models/recommend/fallback_params.rb +3 -3
- data/lib/algolia/models/recommend/recommend_hit.rb +0 -2
- data/lib/algolia/models/recommend/recommend_search_params.rb +3 -3
- data/lib/algolia/models/recommend/recommendations_results.rb +13 -0
- data/lib/algolia/models/recommend/search_recommend_rules_params.rb +2 -2
- data/lib/algolia/models/recommend/trending_facet_hit.rb +0 -2
- data/lib/algolia/models/search/browse_params_object.rb +1 -1
- data/lib/algolia/models/search/browse_response.rb +13 -0
- data/lib/algolia/models/search/consequence_params.rb +1 -1
- data/lib/algolia/models/search/get_api_key_response.rb +2 -0
- data/lib/algolia/models/search/get_objects_response.rb +0 -2
- data/lib/algolia/models/search/index_settings.rb +3 -3
- data/lib/algolia/models/search/search_dictionary_entries_response.rb +1 -1
- data/lib/algolia/models/search/search_for_facets.rb +1 -1
- data/lib/algolia/models/search/search_for_hits.rb +1 -1
- data/lib/algolia/models/search/search_params_object.rb +1 -1
- data/lib/algolia/models/search/search_response.rb +13 -0
- data/lib/algolia/models/search/search_rules_params.rb +2 -2
- data/lib/algolia/models/search/search_user_ids_response.rb +1 -1
- data/lib/algolia/models/search/settings_response.rb +3 -3
- data/lib/algolia/user_agent.rb +8 -2
- data/lib/algolia/version.rb +1 -1
- metadata +2 -2
|
@@ -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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
232
|
-
# @param end_date [String] End date of the period to analyze, in
|
|
233
|
-
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with
|
|
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
|
|
271
|
-
# @param end_date [String] End date of the period to analyze, in
|
|
272
|
-
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with
|
|
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
|
|
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
|
|
289
|
-
# @param end_date [String] End date of the period to analyze, in
|
|
290
|
-
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with
|
|
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
|
|
334
|
-
# @param end_date [String] End date of the period to analyze, in
|
|
335
|
-
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with
|
|
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
|
|
352
|
-
# @param end_date [String] End date of the period to analyze, in
|
|
353
|
-
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with
|
|
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
|
|
391
|
-
# @param end_date [String] End date of the period to analyze, in
|
|
392
|
-
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with
|
|
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
|
|
409
|
-
# @param end_date [String] End date of the period to analyze, in
|
|
410
|
-
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with
|
|
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
|
|
448
|
-
# @param end_date [String] End date of the period to analyze, in
|
|
449
|
-
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with
|
|
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
|
|
466
|
-
# @param end_date [String] End date of the period to analyze, in
|
|
467
|
-
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with
|
|
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
|
|
505
|
-
# @param end_date [String] End date of the period to analyze, in
|
|
506
|
-
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with
|
|
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
|
|
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
|
|
523
|
-
# @param end_date [String] End date of the period to analyze, in
|
|
524
|
-
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with
|
|
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
|
|
562
|
-
# @param end_date [String] End date of the period to analyze, in
|
|
563
|
-
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with
|
|
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
|
|
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
|
|
577
|
-
# @param end_date [String] End date of the period to analyze, in
|
|
578
|
-
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with
|
|
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
|
|
616
|
-
# @param end_date [String] End date of the period to analyze, in
|
|
617
|
-
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with
|
|
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
|
|
634
|
-
# @param end_date [String] End date of the period to analyze, in
|
|
635
|
-
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with
|
|
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
|
|
673
|
-
# @param end_date [String] End date of the period to analyze, in
|
|
674
|
-
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with
|
|
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
|
|
691
|
-
# @param end_date [String] End date of the period to analyze, in
|
|
692
|
-
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with
|
|
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
|
|
730
|
-
# @param end_date [String] End date of the period to analyze, in
|
|
731
|
-
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with
|
|
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
|
|
745
|
-
# @param end_date [String] End date of the period to analyze, in
|
|
746
|
-
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with
|
|
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
|
|
784
|
-
# @param end_date [String] End date of the period to analyze, in
|
|
785
|
-
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with
|
|
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
|
|
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
|
|
802
|
-
# @param end_date [String] End date of the period to analyze, in
|
|
803
|
-
# @param limit [Integer] Number of items to return. Combined with the
|
|
804
|
-
# @param offset [Integer] Position of the first item to return. Combined with the
|
|
805
|
-
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with
|
|
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(
|
|
@@ -849,11 +857,11 @@ module Algolia
|
|
|
849
857
|
# Required API Key ACLs:
|
|
850
858
|
# - analytics
|
|
851
859
|
# @param index [String] Index name. (required)
|
|
852
|
-
# @param start_date [String] Start date of the period to analyze, in
|
|
853
|
-
# @param end_date [String] End date of the period to analyze, in
|
|
854
|
-
# @param limit [Integer] Number of items to return. Combined with the
|
|
855
|
-
# @param offset [Integer] Position of the first item to return. Combined with the
|
|
856
|
-
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with
|
|
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/).
|
|
857
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)
|
|
858
866
|
# @return [GetSearchesNoClicksResponse]
|
|
859
867
|
def get_searches_no_clicks(
|
|
@@ -880,16 +888,16 @@ module Algolia
|
|
|
880
888
|
)
|
|
881
889
|
end
|
|
882
890
|
|
|
883
|
-
# Retrieves the most popular searches that didn
|
|
891
|
+
# Retrieves the most popular searches that didn't return any results.
|
|
884
892
|
#
|
|
885
893
|
# Required API Key ACLs:
|
|
886
894
|
# - analytics
|
|
887
895
|
# @param index [String] Index name. (required)
|
|
888
|
-
# @param start_date [String] Start date of the period to analyze, in
|
|
889
|
-
# @param end_date [String] End date of the period to analyze, in
|
|
890
|
-
# @param limit [Integer] Number of items to return. Combined with the
|
|
891
|
-
# @param offset [Integer] Position of the first item to return. Combined with the
|
|
892
|
-
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with
|
|
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/).
|
|
893
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)
|
|
894
902
|
# @return [Http::Response] the response
|
|
895
903
|
def get_searches_no_results_with_http_info(
|
|
@@ -936,11 +944,11 @@ module Algolia
|
|
|
936
944
|
# Required API Key ACLs:
|
|
937
945
|
# - analytics
|
|
938
946
|
# @param index [String] Index name. (required)
|
|
939
|
-
# @param start_date [String] Start date of the period to analyze, in
|
|
940
|
-
# @param end_date [String] End date of the period to analyze, in
|
|
941
|
-
# @param limit [Integer] Number of items to return. Combined with the
|
|
942
|
-
# @param offset [Integer] Position of the first item to return. Combined with the
|
|
943
|
-
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with
|
|
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/).
|
|
944
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)
|
|
945
953
|
# @return [GetSearchesNoResultsResponse]
|
|
946
954
|
def get_searches_no_results(
|
|
@@ -1017,11 +1025,11 @@ module Algolia
|
|
|
1017
1025
|
# Required API Key ACLs:
|
|
1018
1026
|
# - analytics
|
|
1019
1027
|
# @param index [String] Index name. (required)
|
|
1020
|
-
# @param start_date [String] Start date of the period to analyze, in
|
|
1021
|
-
# @param end_date [String] End date of the period to analyze, in
|
|
1022
|
-
# @param limit [Integer] Number of items to return. Combined with the
|
|
1023
|
-
# @param offset [Integer] Position of the first item to return. Combined with the
|
|
1024
|
-
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with
|
|
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/).
|
|
1025
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)
|
|
1026
1034
|
# @return [Http::Response] the response
|
|
1027
1035
|
def get_top_countries_with_http_info(
|
|
@@ -1068,11 +1076,11 @@ module Algolia
|
|
|
1068
1076
|
# Required API Key ACLs:
|
|
1069
1077
|
# - analytics
|
|
1070
1078
|
# @param index [String] Index name. (required)
|
|
1071
|
-
# @param start_date [String] Start date of the period to analyze, in
|
|
1072
|
-
# @param end_date [String] End date of the period to analyze, in
|
|
1073
|
-
# @param limit [Integer] Number of items to return. Combined with the
|
|
1074
|
-
# @param offset [Integer] Position of the first item to return. Combined with the
|
|
1075
|
-
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with
|
|
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/).
|
|
1076
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)
|
|
1077
1085
|
# @return [GetTopCountriesResponse]
|
|
1078
1086
|
def get_top_countries(
|
|
@@ -1091,17 +1099,17 @@ module Algolia
|
|
|
1091
1099
|
)
|
|
1092
1100
|
end
|
|
1093
1101
|
|
|
1094
|
-
# Retrieves the most frequently used filter attributes. These are attributes of your records that you included in the
|
|
1102
|
+
# Retrieves the most frequently used filter attributes. These are attributes of your records that you included in the `attributesForFaceting` setting.
|
|
1095
1103
|
#
|
|
1096
1104
|
# Required API Key ACLs:
|
|
1097
1105
|
# - analytics
|
|
1098
1106
|
# @param index [String] Index name. (required)
|
|
1099
1107
|
# @param search [String] Search query.
|
|
1100
|
-
# @param start_date [String] Start date of the period to analyze, in
|
|
1101
|
-
# @param end_date [String] End date of the period to analyze, in
|
|
1102
|
-
# @param limit [Integer] Number of items to return. Combined with the
|
|
1103
|
-
# @param offset [Integer] Position of the first item to return. Combined with the
|
|
1104
|
-
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with
|
|
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/).
|
|
1105
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)
|
|
1106
1114
|
# @return [Http::Response] the response
|
|
1107
1115
|
def get_top_filter_attributes_with_http_info(
|
|
@@ -1151,11 +1159,11 @@ module Algolia
|
|
|
1151
1159
|
# - analytics
|
|
1152
1160
|
# @param index [String] Index name. (required)
|
|
1153
1161
|
# @param search [String] Search query.
|
|
1154
|
-
# @param start_date [String] Start date of the period to analyze, in
|
|
1155
|
-
# @param end_date [String] End date of the period to analyze, in
|
|
1156
|
-
# @param limit [Integer] Number of items to return. Combined with the
|
|
1157
|
-
# @param offset [Integer] Position of the first item to return. Combined with the
|
|
1158
|
-
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with
|
|
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/).
|
|
1159
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)
|
|
1160
1168
|
# @return [GetTopFilterAttributesResponse]
|
|
1161
1169
|
def get_top_filter_attributes(
|
|
@@ -1184,18 +1192,18 @@ module Algolia
|
|
|
1184
1192
|
)
|
|
1185
1193
|
end
|
|
1186
1194
|
|
|
1187
|
-
# Retrieves the most frequent filter (facet) values for a filter attribute. These are attributes of your records that you included in the
|
|
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.
|
|
1188
1196
|
#
|
|
1189
1197
|
# Required API Key ACLs:
|
|
1190
1198
|
# - analytics
|
|
1191
1199
|
# @param attribute [String] Attribute name. (required)
|
|
1192
1200
|
# @param index [String] Index name. (required)
|
|
1193
1201
|
# @param search [String] Search query.
|
|
1194
|
-
# @param start_date [String] Start date of the period to analyze, in
|
|
1195
|
-
# @param end_date [String] End date of the period to analyze, in
|
|
1196
|
-
# @param limit [Integer] Number of items to return. Combined with the
|
|
1197
|
-
# @param offset [Integer] Position of the first item to return. Combined with the
|
|
1198
|
-
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with
|
|
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/).
|
|
1199
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)
|
|
1200
1208
|
# @return [Http::Response] the response
|
|
1201
1209
|
def get_top_filter_for_attribute_with_http_info(
|
|
@@ -1251,11 +1259,11 @@ module Algolia
|
|
|
1251
1259
|
# @param attribute [String] Attribute name. (required)
|
|
1252
1260
|
# @param index [String] Index name. (required)
|
|
1253
1261
|
# @param search [String] Search query.
|
|
1254
|
-
# @param start_date [String] Start date of the period to analyze, in
|
|
1255
|
-
# @param end_date [String] End date of the period to analyze, in
|
|
1256
|
-
# @param limit [Integer] Number of items to return. Combined with the
|
|
1257
|
-
# @param offset [Integer] Position of the first item to return. Combined with the
|
|
1258
|
-
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with
|
|
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/).
|
|
1259
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)
|
|
1260
1268
|
# @return [GetTopFilterForAttributeResponse]
|
|
1261
1269
|
def get_top_filter_for_attribute(
|
|
@@ -1286,17 +1294,17 @@ module Algolia
|
|
|
1286
1294
|
)
|
|
1287
1295
|
end
|
|
1288
1296
|
|
|
1289
|
-
# Retrieves the most frequently used filters for a search that didn
|
|
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.
|
|
1290
1298
|
#
|
|
1291
1299
|
# Required API Key ACLs:
|
|
1292
1300
|
# - analytics
|
|
1293
1301
|
# @param index [String] Index name. (required)
|
|
1294
1302
|
# @param search [String] Search query.
|
|
1295
|
-
# @param start_date [String] Start date of the period to analyze, in
|
|
1296
|
-
# @param end_date [String] End date of the period to analyze, in
|
|
1297
|
-
# @param limit [Integer] Number of items to return. Combined with the
|
|
1298
|
-
# @param offset [Integer] Position of the first item to return. Combined with the
|
|
1299
|
-
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with
|
|
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/).
|
|
1300
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)
|
|
1301
1309
|
# @return [Http::Response] the response
|
|
1302
1310
|
def get_top_filters_no_results_with_http_info(
|
|
@@ -1346,11 +1354,11 @@ module Algolia
|
|
|
1346
1354
|
# - analytics
|
|
1347
1355
|
# @param index [String] Index name. (required)
|
|
1348
1356
|
# @param search [String] Search query.
|
|
1349
|
-
# @param start_date [String] Start date of the period to analyze, in
|
|
1350
|
-
# @param end_date [String] End date of the period to analyze, in
|
|
1351
|
-
# @param limit [Integer] Number of items to return. Combined with the
|
|
1352
|
-
# @param offset [Integer] Position of the first item to return. Combined with the
|
|
1353
|
-
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with
|
|
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/).
|
|
1354
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)
|
|
1355
1363
|
# @return [GetTopFiltersNoResultsResponse]
|
|
1356
1364
|
def get_top_filters_no_results(
|
|
@@ -1387,11 +1395,11 @@ module Algolia
|
|
|
1387
1395
|
# @param search [String] Search query.
|
|
1388
1396
|
# @param click_analytics [Boolean] Whether to include metrics related to click and conversion events in the response. (default to false)
|
|
1389
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)
|
|
1390
|
-
# @param start_date [String] Start date of the period to analyze, in
|
|
1391
|
-
# @param end_date [String] End date of the period to analyze, in
|
|
1392
|
-
# @param limit [Integer] Number of items to return. Combined with the
|
|
1393
|
-
# @param offset [Integer] Position of the first item to return. Combined with the
|
|
1394
|
-
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with
|
|
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/).
|
|
1395
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)
|
|
1396
1404
|
# @return [Http::Response] the response
|
|
1397
1405
|
def get_top_hits_with_http_info(
|
|
@@ -1447,11 +1455,11 @@ module Algolia
|
|
|
1447
1455
|
# @param search [String] Search query.
|
|
1448
1456
|
# @param click_analytics [Boolean] Whether to include metrics related to click and conversion events in the response. (default to false)
|
|
1449
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)
|
|
1450
|
-
# @param start_date [String] Start date of the period to analyze, in
|
|
1451
|
-
# @param end_date [String] End date of the period to analyze, in
|
|
1452
|
-
# @param limit [Integer] Number of items to return. Combined with the
|
|
1453
|
-
# @param offset [Integer] Position of the first item to return. Combined with the
|
|
1454
|
-
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with
|
|
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/).
|
|
1455
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)
|
|
1456
1464
|
# @return [GetTopHitsResponse]
|
|
1457
1465
|
def get_top_hits(
|
|
@@ -1488,13 +1496,13 @@ module Algolia
|
|
|
1488
1496
|
# @param index [String] Index name. (required)
|
|
1489
1497
|
# @param click_analytics [Boolean] Whether to include metrics related to click and conversion events in the response. (default to false)
|
|
1490
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)
|
|
1491
|
-
# @param start_date [String] Start date of the period to analyze, in
|
|
1492
|
-
# @param end_date [String] End date of the period to analyze, in
|
|
1493
|
-
# @param order_by [OrderBy] Attribute by which to order the response items. If the
|
|
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')
|
|
1494
1502
|
# @param direction [Direction] Sorting direction of the results: ascending or descending. (default to 'asc')
|
|
1495
|
-
# @param limit [Integer] Number of items to return. Combined with the
|
|
1496
|
-
# @param offset [Integer] Position of the first item to return. Combined with the
|
|
1497
|
-
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with
|
|
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/).
|
|
1498
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)
|
|
1499
1507
|
# @return [Http::Response] the response
|
|
1500
1508
|
def get_top_searches_with_http_info(
|
|
@@ -1551,13 +1559,13 @@ module Algolia
|
|
|
1551
1559
|
# @param index [String] Index name. (required)
|
|
1552
1560
|
# @param click_analytics [Boolean] Whether to include metrics related to click and conversion events in the response. (default to false)
|
|
1553
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)
|
|
1554
|
-
# @param start_date [String] Start date of the period to analyze, in
|
|
1555
|
-
# @param end_date [String] End date of the period to analyze, in
|
|
1556
|
-
# @param order_by [OrderBy] Attribute by which to order the response items. If the
|
|
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')
|
|
1557
1565
|
# @param direction [Direction] Sorting direction of the results: ascending or descending. (default to 'asc')
|
|
1558
|
-
# @param limit [Integer] Number of items to return. Combined with the
|
|
1559
|
-
# @param offset [Integer] Position of the first item to return. Combined with the
|
|
1560
|
-
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with
|
|
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/).
|
|
1561
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)
|
|
1562
1570
|
# @return [GetTopSearchesResponse]
|
|
1563
1571
|
def get_top_searches(
|
|
@@ -1589,14 +1597,14 @@ module Algolia
|
|
|
1589
1597
|
@api_client.deserialize(response.body, request_options[:debug_return_type] || "Analytics::GetTopSearchesResponse")
|
|
1590
1598
|
end
|
|
1591
1599
|
|
|
1592
|
-
# 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
|
|
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.
|
|
1593
1601
|
#
|
|
1594
1602
|
# Required API Key ACLs:
|
|
1595
1603
|
# - analytics
|
|
1596
1604
|
# @param index [String] Index name. (required)
|
|
1597
|
-
# @param start_date [String] Start date of the period to analyze, in
|
|
1598
|
-
# @param end_date [String] End date of the period to analyze, in
|
|
1599
|
-
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with
|
|
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/).
|
|
1600
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)
|
|
1601
1609
|
# @return [Http::Response] the response
|
|
1602
1610
|
def get_users_count_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
|
|
@@ -1633,9 +1641,9 @@ module Algolia
|
|
|
1633
1641
|
# Required API Key ACLs:
|
|
1634
1642
|
# - analytics
|
|
1635
1643
|
# @param index [String] Index name. (required)
|
|
1636
|
-
# @param start_date [String] Start date of the period to analyze, in
|
|
1637
|
-
# @param end_date [String] End date of the period to analyze, in
|
|
1638
|
-
# @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with
|
|
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/).
|
|
1639
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)
|
|
1640
1648
|
# @return [GetUsersCountResponse]
|
|
1641
1649
|
def get_users_count(index, start_date = nil, end_date = nil, tags = nil, request_options = {})
|