@algolia/client-analytics 5.0.0-alpha.11 → 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 (216) hide show
  1. package/dist/builds/browser.d.ts +39 -5
  2. package/dist/builds/browser.d.ts.map +1 -1
  3. package/dist/builds/node.d.ts +39 -5
  4. package/dist/builds/node.d.ts.map +1 -1
  5. package/dist/{client-analytics.cjs.js → client-analytics.cjs} +1083 -924
  6. package/dist/client-analytics.esm.browser.js +1293 -1160
  7. package/dist/client-analytics.esm.node.js +1083 -922
  8. package/dist/client-analytics.umd.js +2 -2
  9. package/dist/model/clickPositionsInner.d.ts +14 -0
  10. package/dist/model/clickPositionsInner.d.ts.map +1 -0
  11. package/dist/model/clientMethodProps.d.ts +578 -507
  12. package/dist/model/clientMethodProps.d.ts.map +1 -1
  13. package/dist/model/currenciesValue.d.ts +14 -0
  14. package/dist/model/currenciesValue.d.ts.map +1 -0
  15. package/dist/model/dailyAddToCartRates.d.ts +19 -0
  16. package/dist/model/dailyAddToCartRates.d.ts.map +1 -0
  17. package/dist/model/dailyAverageClicks.d.ts +15 -0
  18. package/dist/model/dailyAverageClicks.d.ts.map +1 -0
  19. package/dist/model/dailyClickThroughRates.d.ts +19 -0
  20. package/dist/model/dailyClickThroughRates.d.ts.map +1 -0
  21. package/dist/model/dailyConversionRates.d.ts +19 -0
  22. package/dist/model/dailyConversionRates.d.ts.map +1 -0
  23. package/dist/model/dailyNoClickRates.d.ts +19 -0
  24. package/dist/model/dailyNoClickRates.d.ts.map +1 -0
  25. package/dist/model/dailyNoResultsRates.d.ts +19 -0
  26. package/dist/model/dailyNoResultsRates.d.ts.map +1 -0
  27. package/dist/model/dailyPurchaseRates.d.ts +19 -0
  28. package/dist/model/dailyPurchaseRates.d.ts.map +1 -0
  29. package/dist/model/dailyRevenue.d.ts +12 -0
  30. package/dist/model/dailyRevenue.d.ts.map +1 -0
  31. package/dist/model/dailySearches.d.ts +11 -0
  32. package/dist/model/dailySearches.d.ts.map +1 -0
  33. package/dist/model/dailySearchesNoClicks.d.ts +15 -0
  34. package/dist/model/dailySearchesNoClicks.d.ts.map +1 -0
  35. package/dist/model/dailySearchesNoResults.d.ts +15 -0
  36. package/dist/model/dailySearchesNoResults.d.ts.map +1 -0
  37. package/dist/model/dailyUsers.d.ts +11 -0
  38. package/dist/model/dailyUsers.d.ts.map +1 -0
  39. package/dist/model/direction.d.ts +1 -1
  40. package/dist/model/direction.d.ts.map +1 -1
  41. package/dist/model/errorBase.d.ts +6 -6
  42. package/dist/model/errorBase.d.ts.map +1 -1
  43. package/dist/model/getAddToCartRateResponse.d.ts +20 -0
  44. package/dist/model/getAddToCartRateResponse.d.ts.map +1 -0
  45. package/dist/model/getAverageClickPositionResponse.d.ts +15 -15
  46. package/dist/model/getAverageClickPositionResponse.d.ts.map +1 -1
  47. package/dist/model/getClickPositionsResponse.d.ts +7 -7
  48. package/dist/model/getClickPositionsResponse.d.ts.map +1 -1
  49. package/dist/model/getClickThroughRateResponse.d.ts +19 -19
  50. package/dist/model/getClickThroughRateResponse.d.ts.map +1 -1
  51. package/dist/model/getConversionRateResponse.d.ts +20 -0
  52. package/dist/model/getConversionRateResponse.d.ts.map +1 -0
  53. package/dist/model/getNoClickRateResponse.d.ts +19 -19
  54. package/dist/model/getNoClickRateResponse.d.ts.map +1 -1
  55. package/dist/model/getNoResultsRateResponse.d.ts +19 -19
  56. package/dist/model/getNoResultsRateResponse.d.ts.map +1 -1
  57. package/dist/model/getPurchaseRateResponse.d.ts +20 -0
  58. package/dist/model/getPurchaseRateResponse.d.ts.map +1 -0
  59. package/dist/model/getRevenue.d.ts +13 -0
  60. package/dist/model/getRevenue.d.ts.map +1 -0
  61. package/dist/model/getSearchesCountResponse.d.ts +11 -11
  62. package/dist/model/getSearchesCountResponse.d.ts.map +1 -1
  63. package/dist/model/getSearchesNoClicksResponse.d.ts +7 -7
  64. package/dist/model/getSearchesNoClicksResponse.d.ts.map +1 -1
  65. package/dist/model/getSearchesNoResultsResponse.d.ts +7 -7
  66. package/dist/model/getSearchesNoResultsResponse.d.ts.map +1 -1
  67. package/dist/model/getStatusResponse.d.ts +6 -6
  68. package/dist/model/getStatusResponse.d.ts.map +1 -1
  69. package/dist/model/getTopCountriesResponse.d.ts +7 -7
  70. package/dist/model/getTopCountriesResponse.d.ts.map +1 -1
  71. package/dist/model/getTopFilterAttribute.d.ts +10 -10
  72. package/dist/model/getTopFilterAttribute.d.ts.map +1 -1
  73. package/dist/model/getTopFilterAttributesResponse.d.ts +7 -7
  74. package/dist/model/getTopFilterAttributesResponse.d.ts.map +1 -1
  75. package/dist/model/getTopFilterForAttribute.d.ts +16 -18
  76. package/dist/model/getTopFilterForAttribute.d.ts.map +1 -1
  77. package/dist/model/getTopFilterForAttributeResponse.d.ts +7 -7
  78. package/dist/model/getTopFilterForAttributeResponse.d.ts.map +1 -1
  79. package/dist/model/getTopFiltersNoResultsResponse.d.ts +7 -7
  80. package/dist/model/getTopFiltersNoResultsResponse.d.ts.map +1 -1
  81. package/dist/model/getTopFiltersNoResultsValue.d.ts +12 -14
  82. package/dist/model/getTopFiltersNoResultsValue.d.ts.map +1 -1
  83. package/dist/model/getTopFiltersNoResultsValues.d.ts +11 -11
  84. package/dist/model/getTopFiltersNoResultsValues.d.ts.map +1 -1
  85. package/dist/model/getTopHitsResponse.d.ts +4 -3
  86. package/dist/model/getTopHitsResponse.d.ts.map +1 -1
  87. package/dist/model/getTopSearchesResponse.d.ts +4 -3
  88. package/dist/model/getTopSearchesResponse.d.ts.map +1 -1
  89. package/dist/model/getUsersCountResponse.d.ts +11 -11
  90. package/dist/model/getUsersCountResponse.d.ts.map +1 -1
  91. package/dist/model/index.d.ts +56 -44
  92. package/dist/model/index.d.ts.map +1 -1
  93. package/dist/model/operator.d.ts +5 -0
  94. package/dist/model/operator.d.ts.map +1 -0
  95. package/dist/model/orderBy.d.ts +4 -1
  96. package/dist/model/orderBy.d.ts.map +1 -1
  97. package/dist/model/topCountry.d.ts +10 -10
  98. package/dist/model/topCountry.d.ts.map +1 -1
  99. package/dist/model/topHit.d.ts +10 -10
  100. package/dist/model/topHit.d.ts.map +1 -1
  101. package/dist/model/topHitWithAnalytics.d.ts +30 -30
  102. package/dist/model/topHitWithAnalytics.d.ts.map +1 -1
  103. package/dist/model/topHitWithRevenueAnalytics.d.ts +52 -0
  104. package/dist/model/topHitWithRevenueAnalytics.d.ts.map +1 -0
  105. package/dist/model/topHitsResponse.d.ts +7 -7
  106. package/dist/model/topHitsResponse.d.ts.map +1 -1
  107. package/dist/model/topHitsResponseWithAnalytics.d.ts +7 -7
  108. package/dist/model/topHitsResponseWithAnalytics.d.ts.map +1 -1
  109. package/dist/model/topHitsResponseWithRevenueAnalytics.d.ts +8 -0
  110. package/dist/model/topHitsResponseWithRevenueAnalytics.d.ts.map +1 -0
  111. package/dist/model/topSearch.d.ts +14 -14
  112. package/dist/model/topSearch.d.ts.map +1 -1
  113. package/dist/model/topSearchWithAnalytics.d.ts +43 -38
  114. package/dist/model/topSearchWithAnalytics.d.ts.map +1 -1
  115. package/dist/model/topSearchWithRevenueAnalytics.d.ts +65 -0
  116. package/dist/model/topSearchWithRevenueAnalytics.d.ts.map +1 -0
  117. package/dist/model/topSearchesResponse.d.ts +7 -7
  118. package/dist/model/topSearchesResponse.d.ts.map +1 -1
  119. package/dist/model/topSearchesResponseWithAnalytics.d.ts +7 -7
  120. package/dist/model/topSearchesResponseWithAnalytics.d.ts.map +1 -1
  121. package/dist/model/topSearchesResponseWithRevenueAnalytics.d.ts +8 -0
  122. package/dist/model/topSearchesResponseWithRevenueAnalytics.d.ts.map +1 -0
  123. package/dist/src/analyticsClient.d.ts +391 -318
  124. package/dist/src/analyticsClient.d.ts.map +1 -1
  125. package/index.js +1 -1
  126. package/model/clickPositionsInner.ts +16 -0
  127. package/model/clientMethodProps.ts +211 -137
  128. package/model/currenciesValue.ts +16 -0
  129. package/model/dailyAddToCartRates.ts +23 -0
  130. package/model/dailyAverageClicks.ts +18 -0
  131. package/model/dailyClickThroughRates.ts +23 -0
  132. package/model/dailyConversionRates.ts +23 -0
  133. package/model/dailyNoClickRates.ts +23 -0
  134. package/model/dailyNoResultsRates.ts +23 -0
  135. package/model/dailyPurchaseRates.ts +23 -0
  136. package/model/dailyRevenue.ts +15 -0
  137. package/model/dailySearches.ts +13 -0
  138. package/model/dailySearchesNoClicks.ts +18 -0
  139. package/model/dailySearchesNoResults.ts +18 -0
  140. package/model/dailyUsers.ts +13 -0
  141. package/model/direction.ts +1 -1
  142. package/model/errorBase.ts +1 -1
  143. package/model/getAddToCartRateResponse.ts +25 -0
  144. package/model/getAverageClickPositionResponse.ts +7 -7
  145. package/model/getClickPositionsResponse.ts +4 -4
  146. package/model/getClickThroughRateResponse.ts +8 -8
  147. package/model/getConversionRateResponse.ts +25 -0
  148. package/model/getNoClickRateResponse.ts +7 -7
  149. package/model/getNoResultsRateResponse.ts +7 -7
  150. package/model/getPurchaseRateResponse.ts +25 -0
  151. package/model/getRevenue.ts +16 -0
  152. package/model/getSearchesCountResponse.ts +5 -5
  153. package/model/getSearchesNoClicksResponse.ts +4 -4
  154. package/model/getSearchesNoResultsResponse.ts +4 -4
  155. package/model/getStatusResponse.ts +3 -3
  156. package/model/getTopCountriesResponse.ts +2 -2
  157. package/model/getTopFilterAttribute.ts +3 -3
  158. package/model/getTopFilterAttributesResponse.ts +2 -2
  159. package/model/getTopFilterForAttribute.ts +7 -8
  160. package/model/getTopFilterForAttributeResponse.ts +2 -2
  161. package/model/getTopFiltersNoResultsResponse.ts +3 -3
  162. package/model/getTopFiltersNoResultsValue.ts +6 -7
  163. package/model/getTopFiltersNoResultsValues.ts +3 -3
  164. package/model/getTopHitsResponse.ts +6 -2
  165. package/model/getTopSearchesResponse.ts +4 -2
  166. package/model/getUsersCountResponse.ts +5 -5
  167. package/model/index.ts +24 -12
  168. package/model/operator.ts +6 -0
  169. package/model/orderBy.ts +4 -1
  170. package/model/topCountry.ts +3 -3
  171. package/model/topHit.ts +3 -3
  172. package/model/topHitWithAnalytics.ts +11 -11
  173. package/model/topHitWithRevenueAnalytics.ts +65 -0
  174. package/model/topHitsResponse.ts +2 -2
  175. package/model/topHitsResponseWithAnalytics.ts +2 -2
  176. package/model/topHitsResponseWithRevenueAnalytics.ts +10 -0
  177. package/model/topSearch.ts +4 -4
  178. package/model/topSearchWithAnalytics.ts +20 -13
  179. package/model/topSearchWithRevenueAnalytics.ts +81 -0
  180. package/model/topSearchesResponse.ts +2 -2
  181. package/model/topSearchesResponseWithAnalytics.ts +2 -2
  182. package/model/topSearchesResponseWithRevenueAnalytics.ts +10 -0
  183. package/package.json +10 -9
  184. package/dist/model/averageClickEvent.d.ts +0 -15
  185. package/dist/model/averageClickEvent.d.ts.map +0 -1
  186. package/dist/model/clickPosition.d.ts +0 -11
  187. package/dist/model/clickPosition.d.ts.map +0 -1
  188. package/dist/model/clickThroughRateEvent.d.ts +0 -19
  189. package/dist/model/clickThroughRateEvent.d.ts.map +0 -1
  190. package/dist/model/conversionRateEvent.d.ts +0 -19
  191. package/dist/model/conversionRateEvent.d.ts.map +0 -1
  192. package/dist/model/getConversationRateResponse.d.ts +0 -20
  193. package/dist/model/getConversationRateResponse.d.ts.map +0 -1
  194. package/dist/model/noClickRateEvent.d.ts +0 -19
  195. package/dist/model/noClickRateEvent.d.ts.map +0 -1
  196. package/dist/model/noResultsRateEvent.d.ts +0 -19
  197. package/dist/model/noResultsRateEvent.d.ts.map +0 -1
  198. package/dist/model/searchEvent.d.ts +0 -11
  199. package/dist/model/searchEvent.d.ts.map +0 -1
  200. package/dist/model/searchNoClickEvent.d.ts +0 -15
  201. package/dist/model/searchNoClickEvent.d.ts.map +0 -1
  202. package/dist/model/searchNoResultEvent.d.ts +0 -15
  203. package/dist/model/searchNoResultEvent.d.ts.map +0 -1
  204. package/dist/model/userWithDate.d.ts +0 -11
  205. package/dist/model/userWithDate.d.ts.map +0 -1
  206. package/model/averageClickEvent.ts +0 -18
  207. package/model/clickPosition.ts +0 -13
  208. package/model/clickThroughRateEvent.ts +0 -23
  209. package/model/conversionRateEvent.ts +0 -23
  210. package/model/getConversationRateResponse.ts +0 -25
  211. package/model/noClickRateEvent.ts +0 -23
  212. package/model/noResultsRateEvent.ts +0 -23
  213. package/model/searchEvent.ts +0 -13
  214. package/model/searchNoClickEvent.ts +0 -18
  215. package/model/searchNoResultEvent.ts +0 -18
  216. package/model/userWithDate.ts +0 -13
@@ -1,31 +1,31 @@
1
- export declare type TopHitWithAnalytics = {
2
- /**
3
- * The hit.
4
- */
5
- hit: string;
6
- /**
7
- * The number of occurrences.
8
- */
9
- count: number;
10
- /**
11
- * The click-through rate.
12
- */
13
- clickThroughRate: number;
14
- /**
15
- * The conversion rate.
16
- */
17
- conversionRate: number;
18
- /**
19
- * The number of tracked search click.
20
- */
21
- trackedSearchCount: number;
22
- /**
23
- * The number of click event.
24
- */
25
- clickCount: number;
26
- /**
27
- * The number of converted clicks.
28
- */
29
- conversionCount: number;
30
- };
1
+ export type TopHitWithAnalytics = {
2
+ /**
3
+ * Object ID of a record that\'s returned as a search result.
4
+ */
5
+ hit: string;
6
+ /**
7
+ * Number of occurrences.
8
+ */
9
+ count: number;
10
+ /**
11
+ * Click-through rate, calculated as number of tracked searches with at least one click event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
12
+ */
13
+ clickThroughRate: number | null;
14
+ /**
15
+ * Conversion rate, calculated as number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
16
+ */
17
+ conversionRate: number | null;
18
+ /**
19
+ * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
20
+ */
21
+ trackedHitCount: number;
22
+ /**
23
+ * Number of clicks associated with this search.
24
+ */
25
+ clickCount: number;
26
+ /**
27
+ * Number of conversions from this search.
28
+ */
29
+ conversionCount: number;
30
+ };
31
31
  //# sourceMappingURL=topHitWithAnalytics.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"topHitWithAnalytics.d.ts","sourceRoot":"","sources":["../../model/topHitWithAnalytics.ts"],"names":[],"mappings":"AAEA,oBAAY,mBAAmB,GAAG;IAChC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;CACzB,CAAC"}
1
+ {"version":3,"file":"topHitWithAnalytics.d.ts","sourceRoot":"","sources":["../../model/topHitWithAnalytics.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;CACzB,CAAC"}
@@ -0,0 +1,52 @@
1
+ import type { CurrenciesValue } from './currenciesValue';
2
+ export type TopHitWithRevenueAnalytics = {
3
+ /**
4
+ * Object ID of a record that\'s returned as a search result.
5
+ */
6
+ hit: string;
7
+ /**
8
+ * Number of occurrences.
9
+ */
10
+ count: number;
11
+ /**
12
+ * Click-through rate, calculated as number of tracked searches with at least one click event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
13
+ */
14
+ clickThroughRate: number | null;
15
+ /**
16
+ * Conversion rate, calculated as number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
17
+ */
18
+ conversionRate: number | null;
19
+ /**
20
+ * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
21
+ */
22
+ trackedHitCount: number;
23
+ /**
24
+ * Number of clicks associated with this search.
25
+ */
26
+ clickCount: number;
27
+ /**
28
+ * Number of conversions from this search.
29
+ */
30
+ conversionCount: number;
31
+ /**
32
+ * Add-to-cart rate, calculated as number of tracked searches with at least one add-to-cart event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
33
+ */
34
+ addToCartRate: number | null;
35
+ /**
36
+ * Number of add-to-cart events from this search.
37
+ */
38
+ addToCartCount: number;
39
+ /**
40
+ * Purchase rate, calculated as number of tracked searches with at least one purchase event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
41
+ */
42
+ purchaseRate: number | null;
43
+ /**
44
+ * Number of purchase events from this search.
45
+ */
46
+ purchaseCount: number;
47
+ /**
48
+ * Revenue associated with this search, broken-down by currencies.
49
+ */
50
+ currencies: Record<string, CurrenciesValue>;
51
+ };
52
+ //# sourceMappingURL=topHitWithRevenueAnalytics.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"topHitWithRevenueAnalytics.d.ts","sourceRoot":"","sources":["../../model/topHitWithRevenueAnalytics.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD,MAAM,MAAM,0BAA0B,GAAG;IACvC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;CAC7C,CAAC"}
@@ -1,8 +1,8 @@
1
- import type { TopHit } from './topHit';
2
- export declare type TopHitsResponse = {
3
- /**
4
- * A list of top hits with their count.
5
- */
6
- hits: TopHit[];
7
- };
1
+ import type { TopHit } from './topHit';
2
+ export type TopHitsResponse = {
3
+ /**
4
+ * Most frequent search results.
5
+ */
6
+ hits: TopHit[];
7
+ };
8
8
  //# sourceMappingURL=topHitsResponse.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"topHitsResponse.d.ts","sourceRoot":"","sources":["../../model/topHitsResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAEvC,oBAAY,eAAe,GAAG;IAC5B;;OAEG;IACH,IAAI,EAAE,MAAM,EAAE,CAAC;CAChB,CAAC"}
1
+ {"version":3,"file":"topHitsResponse.d.ts","sourceRoot":"","sources":["../../model/topHitsResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAEvC,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,IAAI,EAAE,MAAM,EAAE,CAAC;CAChB,CAAC"}
@@ -1,8 +1,8 @@
1
- import type { TopHitWithAnalytics } from './topHitWithAnalytics';
2
- export declare type TopHitsResponseWithAnalytics = {
3
- /**
4
- * A list of top hits with their count and analytics.
5
- */
6
- hits: TopHitWithAnalytics[];
7
- };
1
+ import type { TopHitWithAnalytics } from './topHitWithAnalytics';
2
+ export type TopHitsResponseWithAnalytics = {
3
+ /**
4
+ * Most frequent search results with click and conversion metrics.
5
+ */
6
+ hits: TopHitWithAnalytics[];
7
+ };
8
8
  //# sourceMappingURL=topHitsResponseWithAnalytics.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"topHitsResponseWithAnalytics.d.ts","sourceRoot":"","sources":["../../model/topHitsResponseWithAnalytics.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAEjE,oBAAY,4BAA4B,GAAG;IACzC;;OAEG;IACH,IAAI,EAAE,mBAAmB,EAAE,CAAC;CAC7B,CAAC"}
1
+ {"version":3,"file":"topHitsResponseWithAnalytics.d.ts","sourceRoot":"","sources":["../../model/topHitsResponseWithAnalytics.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAEjE,MAAM,MAAM,4BAA4B,GAAG;IACzC;;OAEG;IACH,IAAI,EAAE,mBAAmB,EAAE,CAAC;CAC7B,CAAC"}
@@ -0,0 +1,8 @@
1
+ import type { TopHitWithRevenueAnalytics } from './topHitWithRevenueAnalytics';
2
+ export type TopHitsResponseWithRevenueAnalytics = {
3
+ /**
4
+ * Most frequent search results with click, conversion, and revenue metrics.
5
+ */
6
+ hits: TopHitWithRevenueAnalytics[];
7
+ };
8
+ //# sourceMappingURL=topHitsResponseWithRevenueAnalytics.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"topHitsResponseWithRevenueAnalytics.d.ts","sourceRoot":"","sources":["../../model/topHitsResponseWithRevenueAnalytics.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAE/E,MAAM,MAAM,mCAAmC,GAAG;IAChD;;OAEG;IACH,IAAI,EAAE,0BAA0B,EAAE,CAAC;CACpC,CAAC"}
@@ -1,15 +1,15 @@
1
- export declare type TopSearch = {
2
- /**
3
- * The search query.
4
- */
5
- search: string;
6
- /**
7
- * The number of occurrences.
8
- */
9
- count: number;
10
- /**
11
- * Number of hits that the search query matched.
12
- */
13
- nbHits: number;
14
- };
1
+ export type TopSearch = {
2
+ /**
3
+ * Search query.
4
+ */
5
+ search: string;
6
+ /**
7
+ * Number of searches.
8
+ */
9
+ count: number;
10
+ /**
11
+ * Number of results (hits).
12
+ */
13
+ nbHits: number;
14
+ };
15
15
  //# sourceMappingURL=topSearch.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"topSearch.d.ts","sourceRoot":"","sources":["../../model/topSearch.ts"],"names":[],"mappings":"AAEA,oBAAY,SAAS,GAAG;IACtB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC"}
1
+ {"version":3,"file":"topSearch.d.ts","sourceRoot":"","sources":["../../model/topSearch.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,SAAS,GAAG;IACtB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC"}
@@ -1,39 +1,44 @@
1
- export declare type TopSearchWithAnalytics = {
2
- /**
3
- * The search query.
4
- */
5
- search: string;
6
- /**
7
- * The number of occurrences.
8
- */
9
- count: number;
10
- /**
11
- * The click-through rate.
12
- */
13
- clickThroughRate: number;
14
- /**
15
- * The average position of all the click count event.
16
- */
17
- averageClickPosition: number;
18
- /**
19
- * The conversion rate.
20
- */
21
- conversionRate: number;
22
- /**
23
- * The number of tracked search click.
24
- */
25
- trackedSearchCount: number;
26
- /**
27
- * The number of click event.
28
- */
29
- clickCount: number;
30
- /**
31
- * The number of converted clicks.
32
- */
33
- conversionCount: number;
34
- /**
35
- * Number of hits that the search query matched.
36
- */
37
- nbHits: number;
38
- };
1
+ import type { ClickPositionsInner } from './clickPositionsInner';
2
+ export type TopSearchWithAnalytics = {
3
+ /**
4
+ * Search query.
5
+ */
6
+ search: string;
7
+ /**
8
+ * Number of searches.
9
+ */
10
+ count: number;
11
+ /**
12
+ * Click-through rate, calculated as number of tracked searches with at least one click event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
13
+ */
14
+ clickThroughRate: number | null;
15
+ /**
16
+ * Average position of a clicked search result in the list of search results. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
17
+ */
18
+ averageClickPosition: number | null;
19
+ /**
20
+ * List of positions in the search results and clicks associated with this search.
21
+ */
22
+ clickPositions: ClickPositionsInner[];
23
+ /**
24
+ * Conversion rate, calculated as number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
25
+ */
26
+ conversionRate: number | null;
27
+ /**
28
+ * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
29
+ */
30
+ trackedSearchCount: number;
31
+ /**
32
+ * Number of clicks associated with this search.
33
+ */
34
+ clickCount: number;
35
+ /**
36
+ * Number of conversions from this search.
37
+ */
38
+ conversionCount: number;
39
+ /**
40
+ * Number of results (hits).
41
+ */
42
+ nbHits: number;
43
+ };
39
44
  //# sourceMappingURL=topSearchWithAnalytics.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"topSearchWithAnalytics.d.ts","sourceRoot":"","sources":["../../model/topSearchWithAnalytics.ts"],"names":[],"mappings":"AAEA,oBAAY,sBAAsB,GAAG;IACnC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC"}
1
+ {"version":3,"file":"topSearchWithAnalytics.d.ts","sourceRoot":"","sources":["../../model/topSearchWithAnalytics.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAEjE,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,cAAc,EAAE,mBAAmB,EAAE,CAAC;IAEtC;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC"}
@@ -0,0 +1,65 @@
1
+ import type { ClickPositionsInner } from './clickPositionsInner';
2
+ import type { CurrenciesValue } from './currenciesValue';
3
+ export type TopSearchWithRevenueAnalytics = {
4
+ /**
5
+ * Search query.
6
+ */
7
+ search: string;
8
+ /**
9
+ * Number of searches.
10
+ */
11
+ count: number;
12
+ /**
13
+ * Click-through rate, calculated as number of tracked searches with at least one click event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
14
+ */
15
+ clickThroughRate: number | null;
16
+ /**
17
+ * Average position of a clicked search result in the list of search results. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
18
+ */
19
+ averageClickPosition: number | null;
20
+ /**
21
+ * List of positions in the search results and clicks associated with this search.
22
+ */
23
+ clickPositions: ClickPositionsInner[];
24
+ /**
25
+ * Conversion rate, calculated as number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
26
+ */
27
+ conversionRate: number | null;
28
+ /**
29
+ * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
30
+ */
31
+ trackedSearchCount: number;
32
+ /**
33
+ * Number of clicks associated with this search.
34
+ */
35
+ clickCount: number;
36
+ /**
37
+ * Number of conversions from this search.
38
+ */
39
+ conversionCount: number;
40
+ /**
41
+ * Number of results (hits).
42
+ */
43
+ nbHits: number;
44
+ /**
45
+ * Revenue associated with this search, broken-down by currencies.
46
+ */
47
+ currencies: Record<string, CurrenciesValue>;
48
+ /**
49
+ * Add-to-cart rate, calculated as number of tracked searches with at least one add-to-cart event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
50
+ */
51
+ addToCartRate: number | null;
52
+ /**
53
+ * Number of add-to-cart events from this search.
54
+ */
55
+ addToCartCount: number;
56
+ /**
57
+ * Purchase rate, calculated as number of tracked searches with at least one purchase event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
58
+ */
59
+ purchaseRate: number | null;
60
+ /**
61
+ * Number of purchase events from this search.
62
+ */
63
+ purchaseCount: number;
64
+ };
65
+ //# sourceMappingURL=topSearchWithRevenueAnalytics.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"topSearchWithRevenueAnalytics.d.ts","sourceRoot":"","sources":["../../model/topSearchWithRevenueAnalytics.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACjE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD,MAAM,MAAM,6BAA6B,GAAG;IAC1C;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,cAAc,EAAE,mBAAmB,EAAE,CAAC;IAEtC;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IAE5C;;OAEG;IACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;CACvB,CAAC"}
@@ -1,8 +1,8 @@
1
- import type { TopSearch } from './topSearch';
2
- export declare type TopSearchesResponse = {
3
- /**
4
- * A list of top searches with their count.
5
- */
6
- searches: TopSearch[];
7
- };
1
+ import type { TopSearch } from './topSearch';
2
+ export type TopSearchesResponse = {
3
+ /**
4
+ * Most popular searches and their number of search results (hits).
5
+ */
6
+ searches: TopSearch[];
7
+ };
8
8
  //# sourceMappingURL=topSearchesResponse.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"topSearchesResponse.d.ts","sourceRoot":"","sources":["../../model/topSearchesResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C,oBAAY,mBAAmB,GAAG;IAChC;;OAEG;IACH,QAAQ,EAAE,SAAS,EAAE,CAAC;CACvB,CAAC"}
1
+ {"version":3,"file":"topSearchesResponse.d.ts","sourceRoot":"","sources":["../../model/topSearchesResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,QAAQ,EAAE,SAAS,EAAE,CAAC;CACvB,CAAC"}
@@ -1,8 +1,8 @@
1
- import type { TopSearchWithAnalytics } from './topSearchWithAnalytics';
2
- export declare type TopSearchesResponseWithAnalytics = {
3
- /**
4
- * A list of top searches with their count and analytics.
5
- */
6
- searches: TopSearchWithAnalytics[];
7
- };
1
+ import type { TopSearchWithAnalytics } from './topSearchWithAnalytics';
2
+ export type TopSearchesResponseWithAnalytics = {
3
+ /**
4
+ * Most popular searches and their associated click and conversion metrics.
5
+ */
6
+ searches: TopSearchWithAnalytics[];
7
+ };
8
8
  //# sourceMappingURL=topSearchesResponseWithAnalytics.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"topSearchesResponseWithAnalytics.d.ts","sourceRoot":"","sources":["../../model/topSearchesResponseWithAnalytics.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAEvE,oBAAY,gCAAgC,GAAG;IAC7C;;OAEG;IACH,QAAQ,EAAE,sBAAsB,EAAE,CAAC;CACpC,CAAC"}
1
+ {"version":3,"file":"topSearchesResponseWithAnalytics.d.ts","sourceRoot":"","sources":["../../model/topSearchesResponseWithAnalytics.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAEvE,MAAM,MAAM,gCAAgC,GAAG;IAC7C;;OAEG;IACH,QAAQ,EAAE,sBAAsB,EAAE,CAAC;CACpC,CAAC"}
@@ -0,0 +1,8 @@
1
+ import type { TopSearchWithRevenueAnalytics } from './topSearchWithRevenueAnalytics';
2
+ export type TopSearchesResponseWithRevenueAnalytics = {
3
+ /**
4
+ * Most popular searches, including their click and revenue metrics.
5
+ */
6
+ searches: TopSearchWithRevenueAnalytics[];
7
+ };
8
+ //# sourceMappingURL=topSearchesResponseWithRevenueAnalytics.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"topSearchesResponseWithRevenueAnalytics.d.ts","sourceRoot":"","sources":["../../model/topSearchesResponseWithRevenueAnalytics.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AAErF,MAAM,MAAM,uCAAuC,GAAG;IACpD;;OAEG;IACH,QAAQ,EAAE,6BAA6B,EAAE,CAAC;CAC3C,CAAC"}