@algolia/client-analytics 5.9.0 → 5.10.0-beta.1

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 (78) hide show
  1. package/README.md +4 -4
  2. package/dist/browser.d.ts +33 -33
  3. package/dist/builds/browser.js +17 -17
  4. package/dist/builds/browser.js.map +1 -1
  5. package/dist/builds/browser.min.js +1 -1
  6. package/dist/builds/browser.min.js.map +1 -1
  7. package/dist/builds/browser.umd.js +1 -1
  8. package/dist/builds/fetch.js +17 -17
  9. package/dist/builds/fetch.js.map +1 -1
  10. package/dist/builds/node.cjs +17 -17
  11. package/dist/builds/node.cjs.map +1 -1
  12. package/dist/builds/node.js +17 -17
  13. package/dist/builds/node.js.map +1 -1
  14. package/dist/fetch.d.ts +33 -33
  15. package/dist/node.d.cts +33 -33
  16. package/dist/node.d.ts +33 -33
  17. package/dist/src/analyticsClient.cjs +17 -17
  18. package/dist/src/analyticsClient.cjs.map +1 -1
  19. package/dist/src/analyticsClient.js +17 -17
  20. package/dist/src/analyticsClient.js.map +1 -1
  21. package/package.json +6 -7
  22. package/model/clickPosition.ts +0 -16
  23. package/model/clientMethodProps.ts +0 -605
  24. package/model/currencyCode.ts +0 -16
  25. package/model/dailyAddToCartRates.ts +0 -23
  26. package/model/dailyAverageClicks.ts +0 -18
  27. package/model/dailyClickThroughRates.ts +0 -23
  28. package/model/dailyConversionRates.ts +0 -23
  29. package/model/dailyNoClickRates.ts +0 -23
  30. package/model/dailyNoResultsRates.ts +0 -23
  31. package/model/dailyPurchaseRates.ts +0 -23
  32. package/model/dailyRevenue.ts +0 -15
  33. package/model/dailySearches.ts +0 -13
  34. package/model/dailySearchesNoClicks.ts +0 -18
  35. package/model/dailySearchesNoResults.ts +0 -18
  36. package/model/dailyUsers.ts +0 -13
  37. package/model/direction.ts +0 -3
  38. package/model/errorBase.ts +0 -8
  39. package/model/getAddToCartRateResponse.ts +0 -25
  40. package/model/getAverageClickPositionResponse.ts +0 -20
  41. package/model/getClickPositionsResponse.ts +0 -10
  42. package/model/getClickThroughRateResponse.ts +0 -25
  43. package/model/getConversionRateResponse.ts +0 -25
  44. package/model/getNoClickRateResponse.ts +0 -25
  45. package/model/getNoResultsRateResponse.ts +0 -25
  46. package/model/getPurchaseRateResponse.ts +0 -25
  47. package/model/getRevenue.ts +0 -16
  48. package/model/getSearchesCountResponse.ts +0 -15
  49. package/model/getSearchesNoClicksResponse.ts +0 -10
  50. package/model/getSearchesNoResultsResponse.ts +0 -10
  51. package/model/getStatusResponse.ts +0 -8
  52. package/model/getTopCountriesResponse.ts +0 -10
  53. package/model/getTopFilterAttribute.ts +0 -13
  54. package/model/getTopFilterAttributesResponse.ts +0 -10
  55. package/model/getTopFilterForAttribute.ts +0 -22
  56. package/model/getTopFilterForAttributeResponse.ts +0 -10
  57. package/model/getTopFiltersNoResultsResponse.ts +0 -10
  58. package/model/getTopFiltersNoResultsValue.ts +0 -17
  59. package/model/getTopFiltersNoResultsValues.ts +0 -15
  60. package/model/getTopHitsResponse.ts +0 -7
  61. package/model/getTopSearchesResponse.ts +0 -10
  62. package/model/getUsersCountResponse.ts +0 -15
  63. package/model/index.ts +0 -58
  64. package/model/operator.ts +0 -6
  65. package/model/orderBy.ts +0 -6
  66. package/model/topCountry.ts +0 -13
  67. package/model/topHit.ts +0 -13
  68. package/model/topHitWithAnalytics.ts +0 -38
  69. package/model/topHitWithRevenueAnalytics.ts +0 -65
  70. package/model/topHitsResponse.ts +0 -10
  71. package/model/topHitsResponseWithAnalytics.ts +0 -10
  72. package/model/topHitsResponseWithRevenueAnalytics.ts +0 -10
  73. package/model/topSearch.ts +0 -18
  74. package/model/topSearchWithAnalytics.ts +0 -55
  75. package/model/topSearchWithRevenueAnalytics.ts +0 -81
  76. package/model/topSearchesResponse.ts +0 -10
  77. package/model/topSearchesResponseWithAnalytics.ts +0 -10
  78. package/model/topSearchesResponseWithRevenueAnalytics.ts +0 -10
package/dist/node.d.cts CHANGED
@@ -1075,11 +1075,11 @@ type GetSearchesNoClicksProps = {
1075
1075
  */
1076
1076
  endDate?: string;
1077
1077
  /**
1078
- * Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
1078
+ * Number of items to return.
1079
1079
  */
1080
1080
  limit?: number;
1081
1081
  /**
1082
- * Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
1082
+ * Position of the first item to return.
1083
1083
  */
1084
1084
  offset?: number;
1085
1085
  /**
@@ -1104,11 +1104,11 @@ type GetSearchesNoResultsProps = {
1104
1104
  */
1105
1105
  endDate?: string;
1106
1106
  /**
1107
- * Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
1107
+ * Number of items to return.
1108
1108
  */
1109
1109
  limit?: number;
1110
1110
  /**
1111
- * Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
1111
+ * Position of the first item to return.
1112
1112
  */
1113
1113
  offset?: number;
1114
1114
  /**
@@ -1142,11 +1142,11 @@ type GetTopCountriesProps = {
1142
1142
  */
1143
1143
  endDate?: string;
1144
1144
  /**
1145
- * Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
1145
+ * Number of items to return.
1146
1146
  */
1147
1147
  limit?: number;
1148
1148
  /**
1149
- * Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
1149
+ * Position of the first item to return.
1150
1150
  */
1151
1151
  offset?: number;
1152
1152
  /**
@@ -1175,11 +1175,11 @@ type GetTopFilterAttributesProps = {
1175
1175
  */
1176
1176
  endDate?: string;
1177
1177
  /**
1178
- * Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
1178
+ * Number of items to return.
1179
1179
  */
1180
1180
  limit?: number;
1181
1181
  /**
1182
- * Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
1182
+ * Position of the first item to return.
1183
1183
  */
1184
1184
  offset?: number;
1185
1185
  /**
@@ -1212,11 +1212,11 @@ type GetTopFilterForAttributeProps = {
1212
1212
  */
1213
1213
  endDate?: string;
1214
1214
  /**
1215
- * Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
1215
+ * Number of items to return.
1216
1216
  */
1217
1217
  limit?: number;
1218
1218
  /**
1219
- * Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
1219
+ * Position of the first item to return.
1220
1220
  */
1221
1221
  offset?: number;
1222
1222
  /**
@@ -1245,11 +1245,11 @@ type GetTopFiltersNoResultsProps = {
1245
1245
  */
1246
1246
  endDate?: string;
1247
1247
  /**
1248
- * Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
1248
+ * Number of items to return.
1249
1249
  */
1250
1250
  limit?: number;
1251
1251
  /**
1252
- * Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
1252
+ * Position of the first item to return.
1253
1253
  */
1254
1254
  offset?: number;
1255
1255
  /**
@@ -1286,11 +1286,11 @@ type GetTopHitsProps = {
1286
1286
  */
1287
1287
  endDate?: string;
1288
1288
  /**
1289
- * Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
1289
+ * Number of items to return.
1290
1290
  */
1291
1291
  limit?: number;
1292
1292
  /**
1293
- * Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
1293
+ * Position of the first item to return.
1294
1294
  */
1295
1295
  offset?: number;
1296
1296
  /**
@@ -1331,11 +1331,11 @@ type GetTopSearchesProps = {
1331
1331
  */
1332
1332
  direction?: Direction;
1333
1333
  /**
1334
- * Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
1334
+ * Number of items to return.
1335
1335
  */
1336
1336
  limit?: number;
1337
1337
  /**
1338
- * Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
1338
+ * Position of the first item to return.
1339
1339
  */
1340
1340
  offset?: number;
1341
1341
  /**
@@ -1365,7 +1365,7 @@ type GetUsersCountProps = {
1365
1365
  tags?: string;
1366
1366
  };
1367
1367
 
1368
- declare const apiClientVersion = "5.9.0";
1368
+ declare const apiClientVersion = "5.10.0";
1369
1369
  declare const REGIONS: readonly ["de", "us"];
1370
1370
  type Region = (typeof REGIONS)[number];
1371
1371
  type RegionOptions = {
@@ -1574,8 +1574,8 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
1574
1574
  * @param getSearchesNoClicks.index - Index name.
1575
1575
  * @param getSearchesNoClicks.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
1576
1576
  * @param getSearchesNoClicks.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
1577
- * @param getSearchesNoClicks.limit - Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
1578
- * @param getSearchesNoClicks.offset - Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
1577
+ * @param getSearchesNoClicks.limit - Number of items to return.
1578
+ * @param getSearchesNoClicks.offset - Position of the first item to return.
1579
1579
  * @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/).
1580
1580
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1581
1581
  */
@@ -1589,8 +1589,8 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
1589
1589
  * @param getSearchesNoResults.index - Index name.
1590
1590
  * @param getSearchesNoResults.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
1591
1591
  * @param getSearchesNoResults.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
1592
- * @param getSearchesNoResults.limit - Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
1593
- * @param getSearchesNoResults.offset - Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
1592
+ * @param getSearchesNoResults.limit - Number of items to return.
1593
+ * @param getSearchesNoResults.offset - Position of the first item to return.
1594
1594
  * @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/).
1595
1595
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1596
1596
  */
@@ -1614,8 +1614,8 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
1614
1614
  * @param getTopCountries.index - Index name.
1615
1615
  * @param getTopCountries.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
1616
1616
  * @param getTopCountries.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
1617
- * @param getTopCountries.limit - Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
1618
- * @param getTopCountries.offset - Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
1617
+ * @param getTopCountries.limit - Number of items to return.
1618
+ * @param getTopCountries.offset - Position of the first item to return.
1619
1619
  * @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/).
1620
1620
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1621
1621
  */
@@ -1630,8 +1630,8 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
1630
1630
  * @param getTopFilterAttributes.search - Search query.
1631
1631
  * @param getTopFilterAttributes.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
1632
1632
  * @param getTopFilterAttributes.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
1633
- * @param getTopFilterAttributes.limit - Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
1634
- * @param getTopFilterAttributes.offset - Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
1633
+ * @param getTopFilterAttributes.limit - Number of items to return.
1634
+ * @param getTopFilterAttributes.offset - Position of the first item to return.
1635
1635
  * @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/).
1636
1636
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1637
1637
  */
@@ -1647,8 +1647,8 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
1647
1647
  * @param getTopFilterForAttribute.search - Search query.
1648
1648
  * @param getTopFilterForAttribute.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
1649
1649
  * @param getTopFilterForAttribute.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
1650
- * @param getTopFilterForAttribute.limit - Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
1651
- * @param getTopFilterForAttribute.offset - Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
1650
+ * @param getTopFilterForAttribute.limit - Number of items to return.
1651
+ * @param getTopFilterForAttribute.offset - Position of the first item to return.
1652
1652
  * @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/).
1653
1653
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1654
1654
  */
@@ -1663,8 +1663,8 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
1663
1663
  * @param getTopFiltersNoResults.search - Search query.
1664
1664
  * @param getTopFiltersNoResults.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
1665
1665
  * @param getTopFiltersNoResults.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
1666
- * @param getTopFiltersNoResults.limit - Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
1667
- * @param getTopFiltersNoResults.offset - Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
1666
+ * @param getTopFiltersNoResults.limit - Number of items to return.
1667
+ * @param getTopFiltersNoResults.offset - Position of the first item to return.
1668
1668
  * @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/).
1669
1669
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1670
1670
  */
@@ -1681,8 +1681,8 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
1681
1681
  * @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.
1682
1682
  * @param getTopHits.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
1683
1683
  * @param getTopHits.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
1684
- * @param getTopHits.limit - Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
1685
- * @param getTopHits.offset - Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
1684
+ * @param getTopHits.limit - Number of items to return.
1685
+ * @param getTopHits.offset - Position of the first item to return.
1686
1686
  * @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/).
1687
1687
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1688
1688
  */
@@ -1700,8 +1700,8 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
1700
1700
  * @param getTopSearches.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
1701
1701
  * @param getTopSearches.orderBy - Attribute by which to order the response items. If the `clickAnalytics` parameter is false, only `searchCount` is available.
1702
1702
  * @param getTopSearches.direction - Sorting direction of the results: ascending or descending.
1703
- * @param getTopSearches.limit - Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
1704
- * @param getTopSearches.offset - Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
1703
+ * @param getTopSearches.limit - Number of items to return.
1704
+ * @param getTopSearches.offset - Position of the first item to return.
1705
1705
  * @param getTopSearches.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/).
1706
1706
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1707
1707
  */
package/dist/node.d.ts CHANGED
@@ -1075,11 +1075,11 @@ type GetSearchesNoClicksProps = {
1075
1075
  */
1076
1076
  endDate?: string;
1077
1077
  /**
1078
- * Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
1078
+ * Number of items to return.
1079
1079
  */
1080
1080
  limit?: number;
1081
1081
  /**
1082
- * Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
1082
+ * Position of the first item to return.
1083
1083
  */
1084
1084
  offset?: number;
1085
1085
  /**
@@ -1104,11 +1104,11 @@ type GetSearchesNoResultsProps = {
1104
1104
  */
1105
1105
  endDate?: string;
1106
1106
  /**
1107
- * Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
1107
+ * Number of items to return.
1108
1108
  */
1109
1109
  limit?: number;
1110
1110
  /**
1111
- * Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
1111
+ * Position of the first item to return.
1112
1112
  */
1113
1113
  offset?: number;
1114
1114
  /**
@@ -1142,11 +1142,11 @@ type GetTopCountriesProps = {
1142
1142
  */
1143
1143
  endDate?: string;
1144
1144
  /**
1145
- * Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
1145
+ * Number of items to return.
1146
1146
  */
1147
1147
  limit?: number;
1148
1148
  /**
1149
- * Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
1149
+ * Position of the first item to return.
1150
1150
  */
1151
1151
  offset?: number;
1152
1152
  /**
@@ -1175,11 +1175,11 @@ type GetTopFilterAttributesProps = {
1175
1175
  */
1176
1176
  endDate?: string;
1177
1177
  /**
1178
- * Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
1178
+ * Number of items to return.
1179
1179
  */
1180
1180
  limit?: number;
1181
1181
  /**
1182
- * Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
1182
+ * Position of the first item to return.
1183
1183
  */
1184
1184
  offset?: number;
1185
1185
  /**
@@ -1212,11 +1212,11 @@ type GetTopFilterForAttributeProps = {
1212
1212
  */
1213
1213
  endDate?: string;
1214
1214
  /**
1215
- * Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
1215
+ * Number of items to return.
1216
1216
  */
1217
1217
  limit?: number;
1218
1218
  /**
1219
- * Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
1219
+ * Position of the first item to return.
1220
1220
  */
1221
1221
  offset?: number;
1222
1222
  /**
@@ -1245,11 +1245,11 @@ type GetTopFiltersNoResultsProps = {
1245
1245
  */
1246
1246
  endDate?: string;
1247
1247
  /**
1248
- * Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
1248
+ * Number of items to return.
1249
1249
  */
1250
1250
  limit?: number;
1251
1251
  /**
1252
- * Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
1252
+ * Position of the first item to return.
1253
1253
  */
1254
1254
  offset?: number;
1255
1255
  /**
@@ -1286,11 +1286,11 @@ type GetTopHitsProps = {
1286
1286
  */
1287
1287
  endDate?: string;
1288
1288
  /**
1289
- * Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
1289
+ * Number of items to return.
1290
1290
  */
1291
1291
  limit?: number;
1292
1292
  /**
1293
- * Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
1293
+ * Position of the first item to return.
1294
1294
  */
1295
1295
  offset?: number;
1296
1296
  /**
@@ -1331,11 +1331,11 @@ type GetTopSearchesProps = {
1331
1331
  */
1332
1332
  direction?: Direction;
1333
1333
  /**
1334
- * Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
1334
+ * Number of items to return.
1335
1335
  */
1336
1336
  limit?: number;
1337
1337
  /**
1338
- * Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
1338
+ * Position of the first item to return.
1339
1339
  */
1340
1340
  offset?: number;
1341
1341
  /**
@@ -1365,7 +1365,7 @@ type GetUsersCountProps = {
1365
1365
  tags?: string;
1366
1366
  };
1367
1367
 
1368
- declare const apiClientVersion = "5.9.0";
1368
+ declare const apiClientVersion = "5.10.0";
1369
1369
  declare const REGIONS: readonly ["de", "us"];
1370
1370
  type Region = (typeof REGIONS)[number];
1371
1371
  type RegionOptions = {
@@ -1574,8 +1574,8 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
1574
1574
  * @param getSearchesNoClicks.index - Index name.
1575
1575
  * @param getSearchesNoClicks.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
1576
1576
  * @param getSearchesNoClicks.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
1577
- * @param getSearchesNoClicks.limit - Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
1578
- * @param getSearchesNoClicks.offset - Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
1577
+ * @param getSearchesNoClicks.limit - Number of items to return.
1578
+ * @param getSearchesNoClicks.offset - Position of the first item to return.
1579
1579
  * @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/).
1580
1580
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1581
1581
  */
@@ -1589,8 +1589,8 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
1589
1589
  * @param getSearchesNoResults.index - Index name.
1590
1590
  * @param getSearchesNoResults.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
1591
1591
  * @param getSearchesNoResults.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
1592
- * @param getSearchesNoResults.limit - Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
1593
- * @param getSearchesNoResults.offset - Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
1592
+ * @param getSearchesNoResults.limit - Number of items to return.
1593
+ * @param getSearchesNoResults.offset - Position of the first item to return.
1594
1594
  * @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/).
1595
1595
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1596
1596
  */
@@ -1614,8 +1614,8 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
1614
1614
  * @param getTopCountries.index - Index name.
1615
1615
  * @param getTopCountries.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
1616
1616
  * @param getTopCountries.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
1617
- * @param getTopCountries.limit - Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
1618
- * @param getTopCountries.offset - Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
1617
+ * @param getTopCountries.limit - Number of items to return.
1618
+ * @param getTopCountries.offset - Position of the first item to return.
1619
1619
  * @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/).
1620
1620
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1621
1621
  */
@@ -1630,8 +1630,8 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
1630
1630
  * @param getTopFilterAttributes.search - Search query.
1631
1631
  * @param getTopFilterAttributes.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
1632
1632
  * @param getTopFilterAttributes.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
1633
- * @param getTopFilterAttributes.limit - Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
1634
- * @param getTopFilterAttributes.offset - Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
1633
+ * @param getTopFilterAttributes.limit - Number of items to return.
1634
+ * @param getTopFilterAttributes.offset - Position of the first item to return.
1635
1635
  * @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/).
1636
1636
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1637
1637
  */
@@ -1647,8 +1647,8 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
1647
1647
  * @param getTopFilterForAttribute.search - Search query.
1648
1648
  * @param getTopFilterForAttribute.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
1649
1649
  * @param getTopFilterForAttribute.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
1650
- * @param getTopFilterForAttribute.limit - Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
1651
- * @param getTopFilterForAttribute.offset - Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
1650
+ * @param getTopFilterForAttribute.limit - Number of items to return.
1651
+ * @param getTopFilterForAttribute.offset - Position of the first item to return.
1652
1652
  * @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/).
1653
1653
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1654
1654
  */
@@ -1663,8 +1663,8 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
1663
1663
  * @param getTopFiltersNoResults.search - Search query.
1664
1664
  * @param getTopFiltersNoResults.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
1665
1665
  * @param getTopFiltersNoResults.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
1666
- * @param getTopFiltersNoResults.limit - Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
1667
- * @param getTopFiltersNoResults.offset - Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
1666
+ * @param getTopFiltersNoResults.limit - Number of items to return.
1667
+ * @param getTopFiltersNoResults.offset - Position of the first item to return.
1668
1668
  * @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/).
1669
1669
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1670
1670
  */
@@ -1681,8 +1681,8 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
1681
1681
  * @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.
1682
1682
  * @param getTopHits.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
1683
1683
  * @param getTopHits.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
1684
- * @param getTopHits.limit - Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
1685
- * @param getTopHits.offset - Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
1684
+ * @param getTopHits.limit - Number of items to return.
1685
+ * @param getTopHits.offset - Position of the first item to return.
1686
1686
  * @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/).
1687
1687
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1688
1688
  */
@@ -1700,8 +1700,8 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
1700
1700
  * @param getTopSearches.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
1701
1701
  * @param getTopSearches.orderBy - Attribute by which to order the response items. If the `clickAnalytics` parameter is false, only `searchCount` is available.
1702
1702
  * @param getTopSearches.direction - Sorting direction of the results: ascending or descending.
1703
- * @param getTopSearches.limit - Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
1704
- * @param getTopSearches.offset - Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
1703
+ * @param getTopSearches.limit - Number of items to return.
1704
+ * @param getTopSearches.offset - Position of the first item to return.
1705
1705
  * @param getTopSearches.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/).
1706
1706
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1707
1707
  */
@@ -26,7 +26,7 @@ __export(analyticsClient_exports, {
26
26
  });
27
27
  module.exports = __toCommonJS(analyticsClient_exports);
28
28
  var import_client_common = require("@algolia/client-common");
29
- var apiClientVersion = "5.9.0";
29
+ var apiClientVersion = "5.10.0";
30
30
  var REGIONS = ["de", "us"];
31
31
  function getDefaultHosts(region) {
32
32
  const url = !region ? "analytics.algolia.com" : "analytics.{region}.algolia.com".replace("{region}", region);
@@ -590,8 +590,8 @@ function createAnalyticsClient({
590
590
  * @param getSearchesNoClicks.index - Index name.
591
591
  * @param getSearchesNoClicks.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
592
592
  * @param getSearchesNoClicks.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
593
- * @param getSearchesNoClicks.limit - Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
594
- * @param getSearchesNoClicks.offset - Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
593
+ * @param getSearchesNoClicks.limit - Number of items to return.
594
+ * @param getSearchesNoClicks.offset - Position of the first item to return.
595
595
  * @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/).
596
596
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
597
597
  */
@@ -637,8 +637,8 @@ function createAnalyticsClient({
637
637
  * @param getSearchesNoResults.index - Index name.
638
638
  * @param getSearchesNoResults.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
639
639
  * @param getSearchesNoResults.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
640
- * @param getSearchesNoResults.limit - Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
641
- * @param getSearchesNoResults.offset - Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
640
+ * @param getSearchesNoResults.limit - Number of items to return.
641
+ * @param getSearchesNoResults.offset - Position of the first item to return.
642
642
  * @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/).
643
643
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
644
644
  */
@@ -711,8 +711,8 @@ function createAnalyticsClient({
711
711
  * @param getTopCountries.index - Index name.
712
712
  * @param getTopCountries.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
713
713
  * @param getTopCountries.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
714
- * @param getTopCountries.limit - Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
715
- * @param getTopCountries.offset - Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
714
+ * @param getTopCountries.limit - Number of items to return.
715
+ * @param getTopCountries.offset - Position of the first item to return.
716
716
  * @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/).
717
717
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
718
718
  */
@@ -759,8 +759,8 @@ function createAnalyticsClient({
759
759
  * @param getTopFilterAttributes.search - Search query.
760
760
  * @param getTopFilterAttributes.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
761
761
  * @param getTopFilterAttributes.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
762
- * @param getTopFilterAttributes.limit - Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
763
- * @param getTopFilterAttributes.offset - Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
762
+ * @param getTopFilterAttributes.limit - Number of items to return.
763
+ * @param getTopFilterAttributes.offset - Position of the first item to return.
764
764
  * @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/).
765
765
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
766
766
  */
@@ -811,8 +811,8 @@ function createAnalyticsClient({
811
811
  * @param getTopFilterForAttribute.search - Search query.
812
812
  * @param getTopFilterForAttribute.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
813
813
  * @param getTopFilterForAttribute.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
814
- * @param getTopFilterForAttribute.limit - Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
815
- * @param getTopFilterForAttribute.offset - Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
814
+ * @param getTopFilterForAttribute.limit - Number of items to return.
815
+ * @param getTopFilterForAttribute.offset - Position of the first item to return.
816
816
  * @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/).
817
817
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
818
818
  */
@@ -865,8 +865,8 @@ function createAnalyticsClient({
865
865
  * @param getTopFiltersNoResults.search - Search query.
866
866
  * @param getTopFiltersNoResults.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
867
867
  * @param getTopFiltersNoResults.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
868
- * @param getTopFiltersNoResults.limit - Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
869
- * @param getTopFiltersNoResults.offset - Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
868
+ * @param getTopFiltersNoResults.limit - Number of items to return.
869
+ * @param getTopFiltersNoResults.offset - Position of the first item to return.
870
870
  * @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/).
871
871
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
872
872
  */
@@ -918,8 +918,8 @@ function createAnalyticsClient({
918
918
  * @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.
919
919
  * @param getTopHits.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
920
920
  * @param getTopHits.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
921
- * @param getTopHits.limit - Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
922
- * @param getTopHits.offset - Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
921
+ * @param getTopHits.limit - Number of items to return.
922
+ * @param getTopHits.offset - Position of the first item to return.
923
923
  * @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/).
924
924
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
925
925
  */
@@ -978,8 +978,8 @@ function createAnalyticsClient({
978
978
  * @param getTopSearches.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
979
979
  * @param getTopSearches.orderBy - Attribute by which to order the response items. If the `clickAnalytics` parameter is false, only `searchCount` is available.
980
980
  * @param getTopSearches.direction - Sorting direction of the results: ascending or descending.
981
- * @param getTopSearches.limit - Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved.
982
- * @param getTopSearches.offset - Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved.
981
+ * @param getTopSearches.limit - Number of items to return.
982
+ * @param getTopSearches.offset - Position of the first item to return.
983
983
  * @param getTopSearches.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/).
984
984
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
985
985
  */