@algolia/client-analytics 5.0.0-alpha.106 → 5.0.0-alpha.107

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.
Files changed (14) hide show
  1. package/dist/client-analytics.cjs +66 -66
  2. package/dist/client-analytics.esm.browser.js +66 -66
  3. package/dist/client-analytics.esm.node.js +66 -66
  4. package/dist/client-analytics.umd.js +2 -2
  5. package/dist/model/clientMethodProps.d.ts +65 -65
  6. package/dist/model/searchNoResultEvent.d.ts +1 -1
  7. package/dist/model/topSearch.d.ts +1 -1
  8. package/dist/model/topSearchWithAnalytics.d.ts +1 -1
  9. package/dist/src/analyticsClient.d.ts +66 -66
  10. package/model/clientMethodProps.ts +65 -65
  11. package/model/searchNoResultEvent.ts +1 -1
  12. package/model/topSearch.ts +1 -1
  13. package/model/topSearchWithAnalytics.ts +1 -1
  14. package/package.json +7 -7
package/dist/client-analytics.cjs CHANGED
@@ -4,7 +4,7 @@ var clientCommon = require('@algolia/client-common');
4
4
  var requesterNodeHttp = require('@algolia/requester-node-http');
5
5
 
6
6
  // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
7
- const apiClientVersion = '5.0.0-alpha.106';
7
+ const apiClientVersion = '5.0.0-alpha.107';
8
8
  const REGIONS = ['de', 'us'];
9
9
  function getDefaultHosts(region) {
10
10
  const url = !region
@@ -166,9 +166,9 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
166
166
  * - analytics.
167
167
  *
168
168
  * @param getAverageClickPosition - The getAverageClickPosition object.
169
- * @param getAverageClickPosition.index - Index name to target.
170
- * @param getAverageClickPosition.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
171
- * @param getAverageClickPosition.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
169
+ * @param getAverageClickPosition.index - Index name.
170
+ * @param getAverageClickPosition.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
171
+ * @param getAverageClickPosition.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
172
172
  * @param getAverageClickPosition.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
173
173
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
174
174
  */
@@ -206,9 +206,9 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
206
206
  * - analytics.
207
207
  *
208
208
  * @param getClickPositions - The getClickPositions object.
209
- * @param getClickPositions.index - Index name to target.
210
- * @param getClickPositions.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
211
- * @param getClickPositions.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
209
+ * @param getClickPositions.index - Index name.
210
+ * @param getClickPositions.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
211
+ * @param getClickPositions.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
212
212
  * @param getClickPositions.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
213
213
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
214
214
  */
@@ -246,9 +246,9 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
246
246
  * - analytics.
247
247
  *
248
248
  * @param getClickThroughRate - The getClickThroughRate object.
249
- * @param getClickThroughRate.index - Index name to target.
250
- * @param getClickThroughRate.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
251
- * @param getClickThroughRate.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
249
+ * @param getClickThroughRate.index - Index name.
250
+ * @param getClickThroughRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
251
+ * @param getClickThroughRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
252
252
  * @param getClickThroughRate.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
253
253
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
254
254
  */
@@ -286,9 +286,9 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
286
286
  * - analytics.
287
287
  *
288
288
  * @param getConversationRate - The getConversationRate object.
289
- * @param getConversationRate.index - Index name to target.
290
- * @param getConversationRate.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
291
- * @param getConversationRate.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
289
+ * @param getConversationRate.index - Index name.
290
+ * @param getConversationRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
291
+ * @param getConversationRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
292
292
  * @param getConversationRate.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
293
293
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
294
294
  */
@@ -326,9 +326,9 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
326
326
  * - analytics.
327
327
  *
328
328
  * @param getNoClickRate - The getNoClickRate object.
329
- * @param getNoClickRate.index - Index name to target.
330
- * @param getNoClickRate.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
331
- * @param getNoClickRate.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
329
+ * @param getNoClickRate.index - Index name.
330
+ * @param getNoClickRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
331
+ * @param getNoClickRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
332
332
  * @param getNoClickRate.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
333
333
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
334
334
  */
@@ -366,9 +366,9 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
366
366
  * - analytics.
367
367
  *
368
368
  * @param getNoResultsRate - The getNoResultsRate object.
369
- * @param getNoResultsRate.index - Index name to target.
370
- * @param getNoResultsRate.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
371
- * @param getNoResultsRate.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
369
+ * @param getNoResultsRate.index - Index name.
370
+ * @param getNoResultsRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
371
+ * @param getNoResultsRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
372
372
  * @param getNoResultsRate.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
373
373
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
374
374
  */
@@ -406,9 +406,9 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
406
406
  * - analytics.
407
407
  *
408
408
  * @param getSearchesCount - The getSearchesCount object.
409
- * @param getSearchesCount.index - Index name to target.
410
- * @param getSearchesCount.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
411
- * @param getSearchesCount.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
409
+ * @param getSearchesCount.index - Index name.
410
+ * @param getSearchesCount.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
411
+ * @param getSearchesCount.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
412
412
  * @param getSearchesCount.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
413
413
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
414
414
  */
@@ -446,11 +446,11 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
446
446
  * - analytics.
447
447
  *
448
448
  * @param getSearchesNoClicks - The getSearchesNoClicks object.
449
- * @param getSearchesNoClicks.index - Index name to target.
450
- * @param getSearchesNoClicks.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
451
- * @param getSearchesNoClicks.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
452
- * @param getSearchesNoClicks.limit - Number of records to return (page size).
453
- * @param getSearchesNoClicks.offset - Position of the starting record. Used for paging. 0 is the first record.
449
+ * @param getSearchesNoClicks.index - Index name.
450
+ * @param getSearchesNoClicks.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
451
+ * @param getSearchesNoClicks.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
452
+ * @param getSearchesNoClicks.limit - Number of items to return.
453
+ * @param getSearchesNoClicks.offset - Position of the first item to return.
454
454
  * @param getSearchesNoClicks.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
455
455
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
456
456
  */
@@ -494,11 +494,11 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
494
494
  * - analytics.
495
495
  *
496
496
  * @param getSearchesNoResults - The getSearchesNoResults object.
497
- * @param getSearchesNoResults.index - Index name to target.
498
- * @param getSearchesNoResults.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
499
- * @param getSearchesNoResults.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
500
- * @param getSearchesNoResults.limit - Number of records to return (page size).
501
- * @param getSearchesNoResults.offset - Position of the starting record. Used for paging. 0 is the first record.
497
+ * @param getSearchesNoResults.index - Index name.
498
+ * @param getSearchesNoResults.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
499
+ * @param getSearchesNoResults.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
500
+ * @param getSearchesNoResults.limit - Number of items to return.
501
+ * @param getSearchesNoResults.offset - Position of the first item to return.
502
502
  * @param getSearchesNoResults.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
503
503
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
504
504
  */
@@ -542,7 +542,7 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
542
542
  * - analytics.
543
543
  *
544
544
  * @param getStatus - The getStatus object.
545
- * @param getStatus.index - Index name to target.
545
+ * @param getStatus.index - Index name.
546
546
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
547
547
  */
548
548
  getStatus({ index }, requestOptions) {
@@ -570,11 +570,11 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
570
570
  * - analytics.
571
571
  *
572
572
  * @param getTopCountries - The getTopCountries object.
573
- * @param getTopCountries.index - Index name to target.
574
- * @param getTopCountries.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
575
- * @param getTopCountries.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
576
- * @param getTopCountries.limit - Number of records to return (page size).
577
- * @param getTopCountries.offset - Position of the starting record. Used for paging. 0 is the first record.
573
+ * @param getTopCountries.index - Index name.
574
+ * @param getTopCountries.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
575
+ * @param getTopCountries.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
576
+ * @param getTopCountries.limit - Number of items to return.
577
+ * @param getTopCountries.offset - Position of the first item to return.
578
578
  * @param getTopCountries.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
579
579
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
580
580
  */
@@ -618,12 +618,12 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
618
618
  * - analytics.
619
619
  *
620
620
  * @param getTopFilterAttributes - The getTopFilterAttributes object.
621
- * @param getTopFilterAttributes.index - Index name to target.
621
+ * @param getTopFilterAttributes.index - Index name.
622
622
  * @param getTopFilterAttributes.search - User query.
623
- * @param getTopFilterAttributes.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
624
- * @param getTopFilterAttributes.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
625
- * @param getTopFilterAttributes.limit - Number of records to return (page size).
626
- * @param getTopFilterAttributes.offset - Position of the starting record. Used for paging. 0 is the first record.
623
+ * @param getTopFilterAttributes.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
624
+ * @param getTopFilterAttributes.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
625
+ * @param getTopFilterAttributes.limit - Number of items to return.
626
+ * @param getTopFilterAttributes.offset - Position of the first item to return.
627
627
  * @param getTopFilterAttributes.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
628
628
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
629
629
  */
@@ -671,12 +671,12 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
671
671
  *
672
672
  * @param getTopFilterForAttribute - The getTopFilterForAttribute object.
673
673
  * @param getTopFilterForAttribute.attribute - Attribute name.
674
- * @param getTopFilterForAttribute.index - Index name to target.
674
+ * @param getTopFilterForAttribute.index - Index name.
675
675
  * @param getTopFilterForAttribute.search - User query.
676
- * @param getTopFilterForAttribute.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
677
- * @param getTopFilterForAttribute.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
678
- * @param getTopFilterForAttribute.limit - Number of records to return (page size).
679
- * @param getTopFilterForAttribute.offset - Position of the starting record. Used for paging. 0 is the first record.
676
+ * @param getTopFilterForAttribute.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
677
+ * @param getTopFilterForAttribute.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
678
+ * @param getTopFilterForAttribute.limit - Number of items to return.
679
+ * @param getTopFilterForAttribute.offset - Position of the first item to return.
680
680
  * @param getTopFilterForAttribute.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
681
681
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
682
682
  */
@@ -726,12 +726,12 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
726
726
  * - analytics.
727
727
  *
728
728
  * @param getTopFiltersNoResults - The getTopFiltersNoResults object.
729
- * @param getTopFiltersNoResults.index - Index name to target.
729
+ * @param getTopFiltersNoResults.index - Index name.
730
730
  * @param getTopFiltersNoResults.search - User query.
731
- * @param getTopFiltersNoResults.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
732
- * @param getTopFiltersNoResults.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
733
- * @param getTopFiltersNoResults.limit - Number of records to return (page size).
734
- * @param getTopFiltersNoResults.offset - Position of the starting record. Used for paging. 0 is the first record.
731
+ * @param getTopFiltersNoResults.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
732
+ * @param getTopFiltersNoResults.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
733
+ * @param getTopFiltersNoResults.limit - Number of items to return.
734
+ * @param getTopFiltersNoResults.offset - Position of the first item to return.
735
735
  * @param getTopFiltersNoResults.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
736
736
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
737
737
  */
@@ -778,13 +778,13 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
778
778
  * - analytics.
779
779
  *
780
780
  * @param getTopHits - The getTopHits object.
781
- * @param getTopHits.index - Index name to target.
781
+ * @param getTopHits.index - Index name.
782
782
  * @param getTopHits.search - User query.
783
783
  * @param getTopHits.clickAnalytics - Whether to include [click and conversion](https://www.algolia.com/doc/guides/sending-events/getting-started/) rates for a search.
784
- * @param getTopHits.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
785
- * @param getTopHits.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
786
- * @param getTopHits.limit - Number of records to return (page size).
787
- * @param getTopHits.offset - Position of the starting record. Used for paging. 0 is the first record.
784
+ * @param getTopHits.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
785
+ * @param getTopHits.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
786
+ * @param getTopHits.limit - Number of items to return.
787
+ * @param getTopHits.offset - Position of the first item to return.
788
788
  * @param getTopHits.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
789
789
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
790
790
  */
@@ -834,14 +834,14 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
834
834
  * - analytics.
835
835
  *
836
836
  * @param getTopSearches - The getTopSearches object.
837
- * @param getTopSearches.index - Index name to target.
837
+ * @param getTopSearches.index - Index name.
838
838
  * @param getTopSearches.clickAnalytics - Whether to include [click and conversion](https://www.algolia.com/doc/guides/sending-events/getting-started/) rates for a search.
839
- * @param getTopSearches.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
840
- * @param getTopSearches.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
839
+ * @param getTopSearches.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
840
+ * @param getTopSearches.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
841
841
  * @param getTopSearches.orderBy - Reorder the results.
842
842
  * @param getTopSearches.direction - Sorting direction of the results: ascending or descending.
843
- * @param getTopSearches.limit - Number of records to return (page size).
844
- * @param getTopSearches.offset - Position of the starting record. Used for paging. 0 is the first record.
843
+ * @param getTopSearches.limit - Number of items to return.
844
+ * @param getTopSearches.offset - Position of the first item to return.
845
845
  * @param getTopSearches.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
846
846
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
847
847
  */
@@ -894,9 +894,9 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
894
894
  * - analytics.
895
895
  *
896
896
  * @param getUsersCount - The getUsersCount object.
897
- * @param getUsersCount.index - Index name to target.
898
- * @param getUsersCount.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
899
- * @param getUsersCount.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
897
+ * @param getUsersCount.index - Index name.
898
+ * @param getUsersCount.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
899
+ * @param getUsersCount.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
900
900
  * @param getUsersCount.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
901
901
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
902
902
  */
package/dist/client-analytics.esm.browser.js CHANGED
@@ -686,7 +686,7 @@ function createXhrRequester() {
686
686
  }
687
687
 
688
688
  // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
689
- const apiClientVersion = '5.0.0-alpha.106';
689
+ const apiClientVersion = '5.0.0-alpha.107';
690
690
  const REGIONS = ['de', 'us'];
691
691
  function getDefaultHosts(region) {
692
692
  const url = !region
@@ -848,9 +848,9 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
848
848
  * - analytics.
849
849
  *
850
850
  * @param getAverageClickPosition - The getAverageClickPosition object.
851
- * @param getAverageClickPosition.index - Index name to target.
852
- * @param getAverageClickPosition.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
853
- * @param getAverageClickPosition.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
851
+ * @param getAverageClickPosition.index - Index name.
852
+ * @param getAverageClickPosition.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
853
+ * @param getAverageClickPosition.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
854
854
  * @param getAverageClickPosition.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
855
855
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
856
856
  */
@@ -888,9 +888,9 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
888
888
  * - analytics.
889
889
  *
890
890
  * @param getClickPositions - The getClickPositions object.
891
- * @param getClickPositions.index - Index name to target.
892
- * @param getClickPositions.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
893
- * @param getClickPositions.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
891
+ * @param getClickPositions.index - Index name.
892
+ * @param getClickPositions.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
893
+ * @param getClickPositions.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
894
894
  * @param getClickPositions.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
895
895
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
896
896
  */
@@ -928,9 +928,9 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
928
928
  * - analytics.
929
929
  *
930
930
  * @param getClickThroughRate - The getClickThroughRate object.
931
- * @param getClickThroughRate.index - Index name to target.
932
- * @param getClickThroughRate.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
933
- * @param getClickThroughRate.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
931
+ * @param getClickThroughRate.index - Index name.
932
+ * @param getClickThroughRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
933
+ * @param getClickThroughRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
934
934
  * @param getClickThroughRate.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
935
935
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
936
936
  */
@@ -968,9 +968,9 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
968
968
  * - analytics.
969
969
  *
970
970
  * @param getConversationRate - The getConversationRate object.
971
- * @param getConversationRate.index - Index name to target.
972
- * @param getConversationRate.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
973
- * @param getConversationRate.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
971
+ * @param getConversationRate.index - Index name.
972
+ * @param getConversationRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
973
+ * @param getConversationRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
974
974
  * @param getConversationRate.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
975
975
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
976
976
  */
@@ -1008,9 +1008,9 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1008
1008
  * - analytics.
1009
1009
  *
1010
1010
  * @param getNoClickRate - The getNoClickRate object.
1011
- * @param getNoClickRate.index - Index name to target.
1012
- * @param getNoClickRate.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
1013
- * @param getNoClickRate.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
1011
+ * @param getNoClickRate.index - Index name.
1012
+ * @param getNoClickRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
1013
+ * @param getNoClickRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
1014
1014
  * @param getNoClickRate.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
1015
1015
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1016
1016
  */
@@ -1048,9 +1048,9 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1048
1048
  * - analytics.
1049
1049
  *
1050
1050
  * @param getNoResultsRate - The getNoResultsRate object.
1051
- * @param getNoResultsRate.index - Index name to target.
1052
- * @param getNoResultsRate.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
1053
- * @param getNoResultsRate.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
1051
+ * @param getNoResultsRate.index - Index name.
1052
+ * @param getNoResultsRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
1053
+ * @param getNoResultsRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
1054
1054
  * @param getNoResultsRate.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
1055
1055
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1056
1056
  */
@@ -1088,9 +1088,9 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1088
1088
  * - analytics.
1089
1089
  *
1090
1090
  * @param getSearchesCount - The getSearchesCount object.
1091
- * @param getSearchesCount.index - Index name to target.
1092
- * @param getSearchesCount.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
1093
- * @param getSearchesCount.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
1091
+ * @param getSearchesCount.index - Index name.
1092
+ * @param getSearchesCount.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
1093
+ * @param getSearchesCount.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
1094
1094
  * @param getSearchesCount.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
1095
1095
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1096
1096
  */
@@ -1128,11 +1128,11 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1128
1128
  * - analytics.
1129
1129
  *
1130
1130
  * @param getSearchesNoClicks - The getSearchesNoClicks object.
1131
- * @param getSearchesNoClicks.index - Index name to target.
1132
- * @param getSearchesNoClicks.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
1133
- * @param getSearchesNoClicks.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
1134
- * @param getSearchesNoClicks.limit - Number of records to return (page size).
1135
- * @param getSearchesNoClicks.offset - Position of the starting record. Used for paging. 0 is the first record.
1131
+ * @param getSearchesNoClicks.index - Index name.
1132
+ * @param getSearchesNoClicks.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
1133
+ * @param getSearchesNoClicks.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
1134
+ * @param getSearchesNoClicks.limit - Number of items to return.
1135
+ * @param getSearchesNoClicks.offset - Position of the first item to return.
1136
1136
  * @param getSearchesNoClicks.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
1137
1137
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1138
1138
  */
@@ -1176,11 +1176,11 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1176
1176
  * - analytics.
1177
1177
  *
1178
1178
  * @param getSearchesNoResults - The getSearchesNoResults object.
1179
- * @param getSearchesNoResults.index - Index name to target.
1180
- * @param getSearchesNoResults.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
1181
- * @param getSearchesNoResults.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
1182
- * @param getSearchesNoResults.limit - Number of records to return (page size).
1183
- * @param getSearchesNoResults.offset - Position of the starting record. Used for paging. 0 is the first record.
1179
+ * @param getSearchesNoResults.index - Index name.
1180
+ * @param getSearchesNoResults.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
1181
+ * @param getSearchesNoResults.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
1182
+ * @param getSearchesNoResults.limit - Number of items to return.
1183
+ * @param getSearchesNoResults.offset - Position of the first item to return.
1184
1184
  * @param getSearchesNoResults.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
1185
1185
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1186
1186
  */
@@ -1224,7 +1224,7 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1224
1224
  * - analytics.
1225
1225
  *
1226
1226
  * @param getStatus - The getStatus object.
1227
- * @param getStatus.index - Index name to target.
1227
+ * @param getStatus.index - Index name.
1228
1228
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1229
1229
  */
1230
1230
  getStatus({ index }, requestOptions) {
@@ -1252,11 +1252,11 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1252
1252
  * - analytics.
1253
1253
  *
1254
1254
  * @param getTopCountries - The getTopCountries object.
1255
- * @param getTopCountries.index - Index name to target.
1256
- * @param getTopCountries.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
1257
- * @param getTopCountries.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
1258
- * @param getTopCountries.limit - Number of records to return (page size).
1259
- * @param getTopCountries.offset - Position of the starting record. Used for paging. 0 is the first record.
1255
+ * @param getTopCountries.index - Index name.
1256
+ * @param getTopCountries.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
1257
+ * @param getTopCountries.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
1258
+ * @param getTopCountries.limit - Number of items to return.
1259
+ * @param getTopCountries.offset - Position of the first item to return.
1260
1260
  * @param getTopCountries.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
1261
1261
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1262
1262
  */
@@ -1300,12 +1300,12 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1300
1300
  * - analytics.
1301
1301
  *
1302
1302
  * @param getTopFilterAttributes - The getTopFilterAttributes object.
1303
- * @param getTopFilterAttributes.index - Index name to target.
1303
+ * @param getTopFilterAttributes.index - Index name.
1304
1304
  * @param getTopFilterAttributes.search - User query.
1305
- * @param getTopFilterAttributes.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
1306
- * @param getTopFilterAttributes.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
1307
- * @param getTopFilterAttributes.limit - Number of records to return (page size).
1308
- * @param getTopFilterAttributes.offset - Position of the starting record. Used for paging. 0 is the first record.
1305
+ * @param getTopFilterAttributes.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
1306
+ * @param getTopFilterAttributes.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
1307
+ * @param getTopFilterAttributes.limit - Number of items to return.
1308
+ * @param getTopFilterAttributes.offset - Position of the first item to return.
1309
1309
  * @param getTopFilterAttributes.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
1310
1310
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1311
1311
  */
@@ -1353,12 +1353,12 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1353
1353
  *
1354
1354
  * @param getTopFilterForAttribute - The getTopFilterForAttribute object.
1355
1355
  * @param getTopFilterForAttribute.attribute - Attribute name.
1356
- * @param getTopFilterForAttribute.index - Index name to target.
1356
+ * @param getTopFilterForAttribute.index - Index name.
1357
1357
  * @param getTopFilterForAttribute.search - User query.
1358
- * @param getTopFilterForAttribute.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
1359
- * @param getTopFilterForAttribute.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
1360
- * @param getTopFilterForAttribute.limit - Number of records to return (page size).
1361
- * @param getTopFilterForAttribute.offset - Position of the starting record. Used for paging. 0 is the first record.
1358
+ * @param getTopFilterForAttribute.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
1359
+ * @param getTopFilterForAttribute.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
1360
+ * @param getTopFilterForAttribute.limit - Number of items to return.
1361
+ * @param getTopFilterForAttribute.offset - Position of the first item to return.
1362
1362
  * @param getTopFilterForAttribute.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
1363
1363
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1364
1364
  */
@@ -1408,12 +1408,12 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1408
1408
  * - analytics.
1409
1409
  *
1410
1410
  * @param getTopFiltersNoResults - The getTopFiltersNoResults object.
1411
- * @param getTopFiltersNoResults.index - Index name to target.
1411
+ * @param getTopFiltersNoResults.index - Index name.
1412
1412
  * @param getTopFiltersNoResults.search - User query.
1413
- * @param getTopFiltersNoResults.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
1414
- * @param getTopFiltersNoResults.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
1415
- * @param getTopFiltersNoResults.limit - Number of records to return (page size).
1416
- * @param getTopFiltersNoResults.offset - Position of the starting record. Used for paging. 0 is the first record.
1413
+ * @param getTopFiltersNoResults.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
1414
+ * @param getTopFiltersNoResults.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
1415
+ * @param getTopFiltersNoResults.limit - Number of items to return.
1416
+ * @param getTopFiltersNoResults.offset - Position of the first item to return.
1417
1417
  * @param getTopFiltersNoResults.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
1418
1418
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1419
1419
  */
@@ -1460,13 +1460,13 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1460
1460
  * - analytics.
1461
1461
  *
1462
1462
  * @param getTopHits - The getTopHits object.
1463
- * @param getTopHits.index - Index name to target.
1463
+ * @param getTopHits.index - Index name.
1464
1464
  * @param getTopHits.search - User query.
1465
1465
  * @param getTopHits.clickAnalytics - Whether to include [click and conversion](https://www.algolia.com/doc/guides/sending-events/getting-started/) rates for a search.
1466
- * @param getTopHits.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
1467
- * @param getTopHits.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
1468
- * @param getTopHits.limit - Number of records to return (page size).
1469
- * @param getTopHits.offset - Position of the starting record. Used for paging. 0 is the first record.
1466
+ * @param getTopHits.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
1467
+ * @param getTopHits.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
1468
+ * @param getTopHits.limit - Number of items to return.
1469
+ * @param getTopHits.offset - Position of the first item to return.
1470
1470
  * @param getTopHits.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
1471
1471
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1472
1472
  */
@@ -1516,14 +1516,14 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1516
1516
  * - analytics.
1517
1517
  *
1518
1518
  * @param getTopSearches - The getTopSearches object.
1519
- * @param getTopSearches.index - Index name to target.
1519
+ * @param getTopSearches.index - Index name.
1520
1520
  * @param getTopSearches.clickAnalytics - Whether to include [click and conversion](https://www.algolia.com/doc/guides/sending-events/getting-started/) rates for a search.
1521
- * @param getTopSearches.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
1522
- * @param getTopSearches.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
1521
+ * @param getTopSearches.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
1522
+ * @param getTopSearches.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
1523
1523
  * @param getTopSearches.orderBy - Reorder the results.
1524
1524
  * @param getTopSearches.direction - Sorting direction of the results: ascending or descending.
1525
- * @param getTopSearches.limit - Number of records to return (page size).
1526
- * @param getTopSearches.offset - Position of the starting record. Used for paging. 0 is the first record.
1525
+ * @param getTopSearches.limit - Number of items to return.
1526
+ * @param getTopSearches.offset - Position of the first item to return.
1527
1527
  * @param getTopSearches.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
1528
1528
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1529
1529
  */
@@ -1576,9 +1576,9 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1576
1576
  * - analytics.
1577
1577
  *
1578
1578
  * @param getUsersCount - The getUsersCount object.
1579
- * @param getUsersCount.index - Index name to target.
1580
- * @param getUsersCount.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
1581
- * @param getUsersCount.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
1579
+ * @param getUsersCount.index - Index name.
1580
+ * @param getUsersCount.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
1581
+ * @param getUsersCount.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
1582
1582
  * @param getUsersCount.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
1583
1583
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1584
1584
  */