@algolia/client-analytics 5.0.0-alpha.110 → 5.0.0-alpha.111

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 (10) hide show
  1. package/dist/client-analytics.cjs +39 -39
  2. package/dist/client-analytics.esm.browser.js +39 -39
  3. package/dist/client-analytics.esm.node.js +39 -39
  4. package/dist/client-analytics.umd.js +2 -2
  5. package/dist/model/clientMethodProps.d.ts +38 -38
  6. package/dist/model/getStatusResponse.d.ts +1 -1
  7. package/dist/src/analyticsClient.d.ts +39 -39
  8. package/model/clientMethodProps.ts +38 -38
  9. package/model/getStatusResponse.ts +1 -1
  10. 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.110';
7
+ const apiClientVersion = '5.0.0-alpha.111';
8
8
  const REGIONS = ['de', 'us'];
9
9
  function getDefaultHosts(region) {
10
10
  const url = !region
@@ -167,8 +167,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
167
167
  *
168
168
  * @param getAddToCartRate - The getAddToCartRate object.
169
169
  * @param getAddToCartRate.index - Index name.
170
- * @param getAddToCartRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
171
- * @param getAddToCartRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
170
+ * @param getAddToCartRate.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
171
+ * @param getAddToCartRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
172
172
  * @param getAddToCartRate.tags - 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/).
173
173
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
174
174
  */
@@ -207,8 +207,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
207
207
  *
208
208
  * @param getAverageClickPosition - The getAverageClickPosition object.
209
209
  * @param getAverageClickPosition.index - Index name.
210
- * @param getAverageClickPosition.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
211
- * @param getAverageClickPosition.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
210
+ * @param getAverageClickPosition.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
211
+ * @param getAverageClickPosition.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
212
212
  * @param getAverageClickPosition.tags - 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/).
213
213
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
214
214
  */
@@ -247,8 +247,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
247
247
  *
248
248
  * @param getClickPositions - The getClickPositions object.
249
249
  * @param getClickPositions.index - Index name.
250
- * @param getClickPositions.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
251
- * @param getClickPositions.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
250
+ * @param getClickPositions.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
251
+ * @param getClickPositions.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
252
252
  * @param getClickPositions.tags - 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/).
253
253
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
254
254
  */
@@ -287,8 +287,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
287
287
  *
288
288
  * @param getClickThroughRate - The getClickThroughRate object.
289
289
  * @param getClickThroughRate.index - Index name.
290
- * @param getClickThroughRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
291
- * @param getClickThroughRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
290
+ * @param getClickThroughRate.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
291
+ * @param getClickThroughRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
292
292
  * @param getClickThroughRate.tags - 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/).
293
293
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
294
294
  */
@@ -327,8 +327,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
327
327
  *
328
328
  * @param getConversionRate - The getConversionRate object.
329
329
  * @param getConversionRate.index - Index name.
330
- * @param getConversionRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
331
- * @param getConversionRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
330
+ * @param getConversionRate.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
331
+ * @param getConversionRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
332
332
  * @param getConversionRate.tags - 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/).
333
333
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
334
334
  */
@@ -367,8 +367,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
367
367
  *
368
368
  * @param getNoClickRate - The getNoClickRate object.
369
369
  * @param getNoClickRate.index - Index name.
370
- * @param getNoClickRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
371
- * @param getNoClickRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
370
+ * @param getNoClickRate.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
371
+ * @param getNoClickRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
372
372
  * @param getNoClickRate.tags - 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/).
373
373
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
374
374
  */
@@ -407,8 +407,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
407
407
  *
408
408
  * @param getNoResultsRate - The getNoResultsRate object.
409
409
  * @param getNoResultsRate.index - Index name.
410
- * @param getNoResultsRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
411
- * @param getNoResultsRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
410
+ * @param getNoResultsRate.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
411
+ * @param getNoResultsRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
412
412
  * @param getNoResultsRate.tags - 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/).
413
413
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
414
414
  */
@@ -447,8 +447,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
447
447
  *
448
448
  * @param getPurchaseRate - The getPurchaseRate object.
449
449
  * @param getPurchaseRate.index - Index name.
450
- * @param getPurchaseRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
451
- * @param getPurchaseRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
450
+ * @param getPurchaseRate.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
451
+ * @param getPurchaseRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
452
452
  * @param getPurchaseRate.tags - 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/).
453
453
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
454
454
  */
@@ -487,8 +487,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
487
487
  *
488
488
  * @param getRevenue - The getRevenue object.
489
489
  * @param getRevenue.index - Index name.
490
- * @param getRevenue.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
491
- * @param getRevenue.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
490
+ * @param getRevenue.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
491
+ * @param getRevenue.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
492
492
  * @param getRevenue.tags - 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/).
493
493
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
494
494
  */
@@ -527,8 +527,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
527
527
  *
528
528
  * @param getSearchesCount - The getSearchesCount object.
529
529
  * @param getSearchesCount.index - Index name.
530
- * @param getSearchesCount.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
531
- * @param getSearchesCount.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
530
+ * @param getSearchesCount.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
531
+ * @param getSearchesCount.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
532
532
  * @param getSearchesCount.tags - 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/).
533
533
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
534
534
  */
@@ -567,8 +567,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
567
567
  *
568
568
  * @param getSearchesNoClicks - The getSearchesNoClicks object.
569
569
  * @param getSearchesNoClicks.index - Index name.
570
- * @param getSearchesNoClicks.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
571
- * @param getSearchesNoClicks.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
570
+ * @param getSearchesNoClicks.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
571
+ * @param getSearchesNoClicks.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
572
572
  * @param getSearchesNoClicks.limit - Number of items to return.
573
573
  * @param getSearchesNoClicks.offset - Position of the first item to return.
574
574
  * @param getSearchesNoClicks.tags - 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/).
@@ -615,8 +615,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
615
615
  *
616
616
  * @param getSearchesNoResults - The getSearchesNoResults object.
617
617
  * @param getSearchesNoResults.index - Index name.
618
- * @param getSearchesNoResults.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
619
- * @param getSearchesNoResults.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
618
+ * @param getSearchesNoResults.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
619
+ * @param getSearchesNoResults.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
620
620
  * @param getSearchesNoResults.limit - Number of items to return.
621
621
  * @param getSearchesNoResults.offset - Position of the first item to return.
622
622
  * @param getSearchesNoResults.tags - 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/).
@@ -691,8 +691,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
691
691
  *
692
692
  * @param getTopCountries - The getTopCountries object.
693
693
  * @param getTopCountries.index - Index name.
694
- * @param getTopCountries.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
695
- * @param getTopCountries.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
694
+ * @param getTopCountries.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
695
+ * @param getTopCountries.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
696
696
  * @param getTopCountries.limit - Number of items to return.
697
697
  * @param getTopCountries.offset - Position of the first item to return.
698
698
  * @param getTopCountries.tags - 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/).
@@ -740,8 +740,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
740
740
  * @param getTopFilterAttributes - The getTopFilterAttributes object.
741
741
  * @param getTopFilterAttributes.index - Index name.
742
742
  * @param getTopFilterAttributes.search - Search query.
743
- * @param getTopFilterAttributes.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
744
- * @param getTopFilterAttributes.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
743
+ * @param getTopFilterAttributes.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
744
+ * @param getTopFilterAttributes.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
745
745
  * @param getTopFilterAttributes.limit - Number of items to return.
746
746
  * @param getTopFilterAttributes.offset - Position of the first item to return.
747
747
  * @param getTopFilterAttributes.tags - 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/).
@@ -793,8 +793,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
793
793
  * @param getTopFilterForAttribute.attribute - Attribute name.
794
794
  * @param getTopFilterForAttribute.index - Index name.
795
795
  * @param getTopFilterForAttribute.search - Search query.
796
- * @param getTopFilterForAttribute.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
797
- * @param getTopFilterForAttribute.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
796
+ * @param getTopFilterForAttribute.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
797
+ * @param getTopFilterForAttribute.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
798
798
  * @param getTopFilterForAttribute.limit - Number of items to return.
799
799
  * @param getTopFilterForAttribute.offset - Position of the first item to return.
800
800
  * @param getTopFilterForAttribute.tags - 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/).
@@ -848,8 +848,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
848
848
  * @param getTopFiltersNoResults - The getTopFiltersNoResults object.
849
849
  * @param getTopFiltersNoResults.index - Index name.
850
850
  * @param getTopFiltersNoResults.search - Search query.
851
- * @param getTopFiltersNoResults.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
852
- * @param getTopFiltersNoResults.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
851
+ * @param getTopFiltersNoResults.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
852
+ * @param getTopFiltersNoResults.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
853
853
  * @param getTopFiltersNoResults.limit - Number of items to return.
854
854
  * @param getTopFiltersNoResults.offset - Position of the first item to return.
855
855
  * @param getTopFiltersNoResults.tags - 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/).
@@ -902,8 +902,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
902
902
  * @param getTopHits.search - Search query.
903
903
  * @param getTopHits.clickAnalytics - Whether to include metrics related to click and conversion events in the response.
904
904
  * @param getTopHits.revenueAnalytics - Whether to include revenue-related metrics in the response. If true, metrics related to click and conversion events are also included in the response.
905
- * @param getTopHits.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
906
- * @param getTopHits.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
905
+ * @param getTopHits.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
906
+ * @param getTopHits.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
907
907
  * @param getTopHits.limit - Number of items to return.
908
908
  * @param getTopHits.offset - Position of the first item to return.
909
909
  * @param getTopHits.tags - 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/).
@@ -961,8 +961,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
961
961
  * @param getTopSearches.index - Index name.
962
962
  * @param getTopSearches.clickAnalytics - Whether to include metrics related to click and conversion events in the response.
963
963
  * @param getTopSearches.revenueAnalytics - Whether to include revenue-related metrics in the response. If true, metrics related to click and conversion events are also included in the response.
964
- * @param getTopSearches.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
965
- * @param getTopSearches.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
964
+ * @param getTopSearches.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
965
+ * @param getTopSearches.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
966
966
  * @param getTopSearches.orderBy - Attribute by which to order the response items. If the `clickAnalytics` parameter is false, only `searchCount` is available.
967
967
  * @param getTopSearches.direction - Sorting direction of the results: ascending or descending.
968
968
  * @param getTopSearches.limit - Number of items to return.
@@ -1023,8 +1023,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1023
1023
  *
1024
1024
  * @param getUsersCount - The getUsersCount object.
1025
1025
  * @param getUsersCount.index - Index name.
1026
- * @param getUsersCount.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
1027
- * @param getUsersCount.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
1026
+ * @param getUsersCount.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
1027
+ * @param getUsersCount.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
1028
1028
  * @param getUsersCount.tags - 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/).
1029
1029
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1030
1030
  */
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.110';
689
+ const apiClientVersion = '5.0.0-alpha.111';
690
690
  const REGIONS = ['de', 'us'];
691
691
  function getDefaultHosts(region) {
692
692
  const url = !region
@@ -849,8 +849,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
849
849
  *
850
850
  * @param getAddToCartRate - The getAddToCartRate object.
851
851
  * @param getAddToCartRate.index - Index name.
852
- * @param getAddToCartRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
853
- * @param getAddToCartRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
852
+ * @param getAddToCartRate.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
853
+ * @param getAddToCartRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
854
854
  * @param getAddToCartRate.tags - 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/).
855
855
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
856
856
  */
@@ -889,8 +889,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
889
889
  *
890
890
  * @param getAverageClickPosition - The getAverageClickPosition object.
891
891
  * @param getAverageClickPosition.index - Index name.
892
- * @param getAverageClickPosition.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
893
- * @param getAverageClickPosition.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
892
+ * @param getAverageClickPosition.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
893
+ * @param getAverageClickPosition.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
894
894
  * @param getAverageClickPosition.tags - 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/).
895
895
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
896
896
  */
@@ -929,8 +929,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
929
929
  *
930
930
  * @param getClickPositions - The getClickPositions object.
931
931
  * @param getClickPositions.index - Index name.
932
- * @param getClickPositions.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
933
- * @param getClickPositions.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
932
+ * @param getClickPositions.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
933
+ * @param getClickPositions.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
934
934
  * @param getClickPositions.tags - 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/).
935
935
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
936
936
  */
@@ -969,8 +969,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
969
969
  *
970
970
  * @param getClickThroughRate - The getClickThroughRate object.
971
971
  * @param getClickThroughRate.index - Index name.
972
- * @param getClickThroughRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
973
- * @param getClickThroughRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
972
+ * @param getClickThroughRate.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
973
+ * @param getClickThroughRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
974
974
  * @param getClickThroughRate.tags - 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/).
975
975
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
976
976
  */
@@ -1009,8 +1009,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1009
1009
  *
1010
1010
  * @param getConversionRate - The getConversionRate object.
1011
1011
  * @param getConversionRate.index - Index name.
1012
- * @param getConversionRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
1013
- * @param getConversionRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
1012
+ * @param getConversionRate.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
1013
+ * @param getConversionRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
1014
1014
  * @param getConversionRate.tags - 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/).
1015
1015
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1016
1016
  */
@@ -1049,8 +1049,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1049
1049
  *
1050
1050
  * @param getNoClickRate - The getNoClickRate object.
1051
1051
  * @param getNoClickRate.index - Index name.
1052
- * @param getNoClickRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
1053
- * @param getNoClickRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
1052
+ * @param getNoClickRate.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
1053
+ * @param getNoClickRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
1054
1054
  * @param getNoClickRate.tags - 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/).
1055
1055
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1056
1056
  */
@@ -1089,8 +1089,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1089
1089
  *
1090
1090
  * @param getNoResultsRate - The getNoResultsRate object.
1091
1091
  * @param getNoResultsRate.index - Index name.
1092
- * @param getNoResultsRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
1093
- * @param getNoResultsRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
1092
+ * @param getNoResultsRate.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
1093
+ * @param getNoResultsRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
1094
1094
  * @param getNoResultsRate.tags - 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/).
1095
1095
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1096
1096
  */
@@ -1129,8 +1129,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1129
1129
  *
1130
1130
  * @param getPurchaseRate - The getPurchaseRate object.
1131
1131
  * @param getPurchaseRate.index - Index name.
1132
- * @param getPurchaseRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
1133
- * @param getPurchaseRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
1132
+ * @param getPurchaseRate.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
1133
+ * @param getPurchaseRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
1134
1134
  * @param getPurchaseRate.tags - 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/).
1135
1135
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1136
1136
  */
@@ -1169,8 +1169,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1169
1169
  *
1170
1170
  * @param getRevenue - The getRevenue object.
1171
1171
  * @param getRevenue.index - Index name.
1172
- * @param getRevenue.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
1173
- * @param getRevenue.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
1172
+ * @param getRevenue.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
1173
+ * @param getRevenue.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
1174
1174
  * @param getRevenue.tags - 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/).
1175
1175
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1176
1176
  */
@@ -1209,8 +1209,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1209
1209
  *
1210
1210
  * @param getSearchesCount - The getSearchesCount object.
1211
1211
  * @param getSearchesCount.index - Index name.
1212
- * @param getSearchesCount.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
1213
- * @param getSearchesCount.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
1212
+ * @param getSearchesCount.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
1213
+ * @param getSearchesCount.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
1214
1214
  * @param getSearchesCount.tags - 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/).
1215
1215
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1216
1216
  */
@@ -1249,8 +1249,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1249
1249
  *
1250
1250
  * @param getSearchesNoClicks - The getSearchesNoClicks object.
1251
1251
  * @param getSearchesNoClicks.index - Index name.
1252
- * @param getSearchesNoClicks.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
1253
- * @param getSearchesNoClicks.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
1252
+ * @param getSearchesNoClicks.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
1253
+ * @param getSearchesNoClicks.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
1254
1254
  * @param getSearchesNoClicks.limit - Number of items to return.
1255
1255
  * @param getSearchesNoClicks.offset - Position of the first item to return.
1256
1256
  * @param getSearchesNoClicks.tags - 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/).
@@ -1297,8 +1297,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1297
1297
  *
1298
1298
  * @param getSearchesNoResults - The getSearchesNoResults object.
1299
1299
  * @param getSearchesNoResults.index - Index name.
1300
- * @param getSearchesNoResults.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
1301
- * @param getSearchesNoResults.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
1300
+ * @param getSearchesNoResults.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
1301
+ * @param getSearchesNoResults.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
1302
1302
  * @param getSearchesNoResults.limit - Number of items to return.
1303
1303
  * @param getSearchesNoResults.offset - Position of the first item to return.
1304
1304
  * @param getSearchesNoResults.tags - 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/).
@@ -1373,8 +1373,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1373
1373
  *
1374
1374
  * @param getTopCountries - The getTopCountries object.
1375
1375
  * @param getTopCountries.index - Index name.
1376
- * @param getTopCountries.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
1377
- * @param getTopCountries.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
1376
+ * @param getTopCountries.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
1377
+ * @param getTopCountries.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
1378
1378
  * @param getTopCountries.limit - Number of items to return.
1379
1379
  * @param getTopCountries.offset - Position of the first item to return.
1380
1380
  * @param getTopCountries.tags - 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/).
@@ -1422,8 +1422,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1422
1422
  * @param getTopFilterAttributes - The getTopFilterAttributes object.
1423
1423
  * @param getTopFilterAttributes.index - Index name.
1424
1424
  * @param getTopFilterAttributes.search - Search query.
1425
- * @param getTopFilterAttributes.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
1426
- * @param getTopFilterAttributes.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
1425
+ * @param getTopFilterAttributes.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
1426
+ * @param getTopFilterAttributes.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
1427
1427
  * @param getTopFilterAttributes.limit - Number of items to return.
1428
1428
  * @param getTopFilterAttributes.offset - Position of the first item to return.
1429
1429
  * @param getTopFilterAttributes.tags - 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/).
@@ -1475,8 +1475,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1475
1475
  * @param getTopFilterForAttribute.attribute - Attribute name.
1476
1476
  * @param getTopFilterForAttribute.index - Index name.
1477
1477
  * @param getTopFilterForAttribute.search - Search query.
1478
- * @param getTopFilterForAttribute.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
1479
- * @param getTopFilterForAttribute.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
1478
+ * @param getTopFilterForAttribute.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
1479
+ * @param getTopFilterForAttribute.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
1480
1480
  * @param getTopFilterForAttribute.limit - Number of items to return.
1481
1481
  * @param getTopFilterForAttribute.offset - Position of the first item to return.
1482
1482
  * @param getTopFilterForAttribute.tags - 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/).
@@ -1530,8 +1530,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1530
1530
  * @param getTopFiltersNoResults - The getTopFiltersNoResults object.
1531
1531
  * @param getTopFiltersNoResults.index - Index name.
1532
1532
  * @param getTopFiltersNoResults.search - Search query.
1533
- * @param getTopFiltersNoResults.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
1534
- * @param getTopFiltersNoResults.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
1533
+ * @param getTopFiltersNoResults.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
1534
+ * @param getTopFiltersNoResults.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
1535
1535
  * @param getTopFiltersNoResults.limit - Number of items to return.
1536
1536
  * @param getTopFiltersNoResults.offset - Position of the first item to return.
1537
1537
  * @param getTopFiltersNoResults.tags - 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/).
@@ -1584,8 +1584,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1584
1584
  * @param getTopHits.search - Search query.
1585
1585
  * @param getTopHits.clickAnalytics - Whether to include metrics related to click and conversion events in the response.
1586
1586
  * @param getTopHits.revenueAnalytics - Whether to include revenue-related metrics in the response. If true, metrics related to click and conversion events are also included in the response.
1587
- * @param getTopHits.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
1588
- * @param getTopHits.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
1587
+ * @param getTopHits.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
1588
+ * @param getTopHits.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
1589
1589
  * @param getTopHits.limit - Number of items to return.
1590
1590
  * @param getTopHits.offset - Position of the first item to return.
1591
1591
  * @param getTopHits.tags - 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/).
@@ -1643,8 +1643,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1643
1643
  * @param getTopSearches.index - Index name.
1644
1644
  * @param getTopSearches.clickAnalytics - Whether to include metrics related to click and conversion events in the response.
1645
1645
  * @param getTopSearches.revenueAnalytics - Whether to include revenue-related metrics in the response. If true, metrics related to click and conversion events are also included in the response.
1646
- * @param getTopSearches.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
1647
- * @param getTopSearches.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
1646
+ * @param getTopSearches.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
1647
+ * @param getTopSearches.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
1648
1648
  * @param getTopSearches.orderBy - Attribute by which to order the response items. If the `clickAnalytics` parameter is false, only `searchCount` is available.
1649
1649
  * @param getTopSearches.direction - Sorting direction of the results: ascending or descending.
1650
1650
  * @param getTopSearches.limit - Number of items to return.
@@ -1705,8 +1705,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1705
1705
  *
1706
1706
  * @param getUsersCount - The getUsersCount object.
1707
1707
  * @param getUsersCount.index - Index name.
1708
- * @param getUsersCount.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
1709
- * @param getUsersCount.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
1708
+ * @param getUsersCount.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
1709
+ * @param getUsersCount.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
1710
1710
  * @param getUsersCount.tags - 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/).
1711
1711
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1712
1712
  */