@algolia/client-analytics 5.0.0-alpha.98 → 5.0.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 (186) hide show
  1. package/dist/builds/browser.d.ts +37 -3
  2. package/dist/builds/browser.d.ts.map +1 -1
  3. package/dist/builds/node.d.ts +37 -3
  4. package/dist/builds/node.d.ts.map +1 -1
  5. package/dist/client-analytics.cjs +314 -153
  6. package/dist/client-analytics.esm.browser.js +300 -144
  7. package/dist/client-analytics.esm.node.js +314 -153
  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 +161 -90
  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/getAddToCartRateResponse.d.ts +20 -0
  40. package/dist/model/getAddToCartRateResponse.d.ts.map +1 -0
  41. package/dist/model/getAverageClickPositionResponse.d.ts +6 -6
  42. package/dist/model/getAverageClickPositionResponse.d.ts.map +1 -1
  43. package/dist/model/getClickPositionsResponse.d.ts +3 -3
  44. package/dist/model/getClickPositionsResponse.d.ts.map +1 -1
  45. package/dist/model/getClickThroughRateResponse.d.ts +7 -7
  46. package/dist/model/getClickThroughRateResponse.d.ts.map +1 -1
  47. package/dist/model/getConversionRateResponse.d.ts +20 -0
  48. package/dist/model/getConversionRateResponse.d.ts.map +1 -0
  49. package/dist/model/getNoClickRateResponse.d.ts +6 -6
  50. package/dist/model/getNoClickRateResponse.d.ts.map +1 -1
  51. package/dist/model/getNoResultsRateResponse.d.ts +6 -6
  52. package/dist/model/getNoResultsRateResponse.d.ts.map +1 -1
  53. package/dist/model/getPurchaseRateResponse.d.ts +20 -0
  54. package/dist/model/getPurchaseRateResponse.d.ts.map +1 -0
  55. package/dist/model/getRevenue.d.ts +13 -0
  56. package/dist/model/getRevenue.d.ts.map +1 -0
  57. package/dist/model/getSearchesCountResponse.d.ts +3 -3
  58. package/dist/model/getSearchesCountResponse.d.ts.map +1 -1
  59. package/dist/model/getSearchesNoClicksResponse.d.ts +3 -3
  60. package/dist/model/getSearchesNoClicksResponse.d.ts.map +1 -1
  61. package/dist/model/getSearchesNoResultsResponse.d.ts +3 -3
  62. package/dist/model/getSearchesNoResultsResponse.d.ts.map +1 -1
  63. package/dist/model/getStatusResponse.d.ts +2 -2
  64. package/dist/model/getStatusResponse.d.ts.map +1 -1
  65. package/dist/model/getTopCountriesResponse.d.ts +1 -1
  66. package/dist/model/getTopFilterAttributesResponse.d.ts +1 -1
  67. package/dist/model/getTopFilterForAttribute.d.ts +2 -4
  68. package/dist/model/getTopFilterForAttribute.d.ts.map +1 -1
  69. package/dist/model/getTopFiltersNoResultsResponse.d.ts +2 -2
  70. package/dist/model/getTopFiltersNoResultsResponse.d.ts.map +1 -1
  71. package/dist/model/getTopFiltersNoResultsValue.d.ts +2 -4
  72. package/dist/model/getTopFiltersNoResultsValue.d.ts.map +1 -1
  73. package/dist/model/getTopHitsResponse.d.ts +2 -1
  74. package/dist/model/getTopHitsResponse.d.ts.map +1 -1
  75. package/dist/model/getTopSearchesResponse.d.ts +2 -1
  76. package/dist/model/getTopSearchesResponse.d.ts.map +1 -1
  77. package/dist/model/getUsersCountResponse.d.ts +4 -4
  78. package/dist/model/getUsersCountResponse.d.ts.map +1 -1
  79. package/dist/model/index.d.ts +23 -11
  80. package/dist/model/index.d.ts.map +1 -1
  81. package/dist/model/operator.d.ts +5 -0
  82. package/dist/model/operator.d.ts.map +1 -0
  83. package/dist/model/orderBy.d.ts +1 -1
  84. package/dist/model/topCountry.d.ts +1 -1
  85. package/dist/model/topHit.d.ts +1 -1
  86. package/dist/model/topHitWithAnalytics.d.ts +9 -9
  87. package/dist/model/topHitWithAnalytics.d.ts.map +1 -1
  88. package/dist/model/topHitWithRevenueAnalytics.d.ts +52 -0
  89. package/dist/model/topHitWithRevenueAnalytics.d.ts.map +1 -0
  90. package/dist/model/topHitsResponse.d.ts +1 -1
  91. package/dist/model/topHitsResponseWithAnalytics.d.ts +1 -1
  92. package/dist/model/topHitsResponseWithRevenueAnalytics.d.ts +8 -0
  93. package/dist/model/topHitsResponseWithRevenueAnalytics.d.ts.map +1 -0
  94. package/dist/model/topSearch.d.ts +3 -3
  95. package/dist/model/topSearchWithAnalytics.d.ts +17 -12
  96. package/dist/model/topSearchWithAnalytics.d.ts.map +1 -1
  97. package/dist/model/topSearchWithRevenueAnalytics.d.ts +65 -0
  98. package/dist/model/topSearchWithRevenueAnalytics.d.ts.map +1 -0
  99. package/dist/model/topSearchesResponse.d.ts +1 -1
  100. package/dist/model/topSearchesResponseWithAnalytics.d.ts +1 -1
  101. package/dist/model/topSearchesResponseWithRevenueAnalytics.d.ts +8 -0
  102. package/dist/model/topSearchesResponseWithRevenueAnalytics.d.ts.map +1 -0
  103. package/dist/src/analyticsClient.d.ts +211 -138
  104. package/dist/src/analyticsClient.d.ts.map +1 -1
  105. package/model/clickPositionsInner.ts +16 -0
  106. package/model/clientMethodProps.ts +164 -90
  107. package/model/currenciesValue.ts +16 -0
  108. package/model/dailyAddToCartRates.ts +23 -0
  109. package/model/dailyAverageClicks.ts +18 -0
  110. package/model/dailyClickThroughRates.ts +23 -0
  111. package/model/dailyConversionRates.ts +23 -0
  112. package/model/dailyNoClickRates.ts +23 -0
  113. package/model/dailyNoResultsRates.ts +23 -0
  114. package/model/dailyPurchaseRates.ts +23 -0
  115. package/model/dailyRevenue.ts +15 -0
  116. package/model/{searchEvent.ts → dailySearches.ts} +2 -2
  117. package/model/{searchNoResultEvent.ts → dailySearchesNoClicks.ts} +4 -4
  118. package/model/{searchNoClickEvent.ts → dailySearchesNoResults.ts} +3 -3
  119. package/model/{userWithDate.ts → dailyUsers.ts} +3 -3
  120. package/model/getAddToCartRateResponse.ts +25 -0
  121. package/model/getAverageClickPositionResponse.ts +6 -6
  122. package/model/getClickPositionsResponse.ts +3 -3
  123. package/model/getClickThroughRateResponse.ts +7 -7
  124. package/model/getConversionRateResponse.ts +25 -0
  125. package/model/getNoClickRateResponse.ts +6 -6
  126. package/model/getNoResultsRateResponse.ts +6 -6
  127. package/model/getPurchaseRateResponse.ts +25 -0
  128. package/model/getRevenue.ts +16 -0
  129. package/model/getSearchesCountResponse.ts +3 -3
  130. package/model/getSearchesNoClicksResponse.ts +3 -3
  131. package/model/getSearchesNoResultsResponse.ts +3 -3
  132. package/model/getStatusResponse.ts +2 -2
  133. package/model/getTopCountriesResponse.ts +1 -1
  134. package/model/getTopFilterAttributesResponse.ts +1 -1
  135. package/model/getTopFilterForAttribute.ts +3 -4
  136. package/model/getTopFiltersNoResultsResponse.ts +2 -2
  137. package/model/getTopFiltersNoResultsValue.ts +3 -4
  138. package/model/getTopHitsResponse.ts +5 -1
  139. package/model/getTopSearchesResponse.ts +3 -1
  140. package/model/getUsersCountResponse.ts +4 -4
  141. package/model/index.ts +23 -11
  142. package/model/operator.ts +6 -0
  143. package/model/orderBy.ts +1 -1
  144. package/model/topCountry.ts +1 -1
  145. package/model/topHit.ts +1 -1
  146. package/model/topHitWithAnalytics.ts +9 -9
  147. package/model/topHitWithRevenueAnalytics.ts +65 -0
  148. package/model/topHitsResponse.ts +1 -1
  149. package/model/topHitsResponseWithAnalytics.ts +1 -1
  150. package/model/topHitsResponseWithRevenueAnalytics.ts +10 -0
  151. package/model/topSearch.ts +3 -3
  152. package/model/topSearchWithAnalytics.ts +19 -12
  153. package/model/topSearchWithRevenueAnalytics.ts +81 -0
  154. package/model/topSearchesResponse.ts +1 -1
  155. package/model/topSearchesResponseWithAnalytics.ts +1 -1
  156. package/model/topSearchesResponseWithRevenueAnalytics.ts +10 -0
  157. package/package.json +7 -7
  158. package/dist/model/averageClickEvent.d.ts +0 -15
  159. package/dist/model/averageClickEvent.d.ts.map +0 -1
  160. package/dist/model/clickPosition.d.ts +0 -11
  161. package/dist/model/clickPosition.d.ts.map +0 -1
  162. package/dist/model/clickThroughRateEvent.d.ts +0 -19
  163. package/dist/model/clickThroughRateEvent.d.ts.map +0 -1
  164. package/dist/model/conversionRateEvent.d.ts +0 -19
  165. package/dist/model/conversionRateEvent.d.ts.map +0 -1
  166. package/dist/model/getConversationRateResponse.d.ts +0 -20
  167. package/dist/model/getConversationRateResponse.d.ts.map +0 -1
  168. package/dist/model/noClickRateEvent.d.ts +0 -19
  169. package/dist/model/noClickRateEvent.d.ts.map +0 -1
  170. package/dist/model/noResultsRateEvent.d.ts +0 -19
  171. package/dist/model/noResultsRateEvent.d.ts.map +0 -1
  172. package/dist/model/searchEvent.d.ts +0 -11
  173. package/dist/model/searchEvent.d.ts.map +0 -1
  174. package/dist/model/searchNoClickEvent.d.ts +0 -15
  175. package/dist/model/searchNoClickEvent.d.ts.map +0 -1
  176. package/dist/model/searchNoResultEvent.d.ts +0 -15
  177. package/dist/model/searchNoResultEvent.d.ts.map +0 -1
  178. package/dist/model/userWithDate.d.ts +0 -11
  179. package/dist/model/userWithDate.d.ts.map +0 -1
  180. package/model/averageClickEvent.ts +0 -18
  181. package/model/clickPosition.ts +0 -13
  182. package/model/clickThroughRateEvent.ts +0 -23
  183. package/model/conversionRateEvent.ts +0 -23
  184. package/model/getConversationRateResponse.ts +0 -25
  185. package/model/noClickRateEvent.ts +0 -23
  186. package/model/noResultsRateEvent.ts +0 -23
package/model/index.ts CHANGED
@@ -1,17 +1,30 @@
1
1
  // 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.
2
2
 
3
- export * from './averageClickEvent';
4
- export * from './clickPosition';
5
- export * from './clickThroughRateEvent';
6
- export * from './conversionRateEvent';
3
+ export * from './clickPositionsInner';
4
+ export * from './currenciesValue';
5
+ export * from './dailyAddToCartRates';
6
+ export * from './dailyAverageClicks';
7
+ export * from './dailyClickThroughRates';
8
+ export * from './dailyConversionRates';
9
+ export * from './dailyNoClickRates';
10
+ export * from './dailyNoResultsRates';
11
+ export * from './dailyPurchaseRates';
12
+ export * from './dailyRevenue';
13
+ export * from './dailySearches';
14
+ export * from './dailySearchesNoClicks';
15
+ export * from './dailySearchesNoResults';
16
+ export * from './dailyUsers';
7
17
  export * from './direction';
8
18
  export * from './errorBase';
19
+ export * from './getAddToCartRateResponse';
9
20
  export * from './getAverageClickPositionResponse';
10
21
  export * from './getClickPositionsResponse';
11
22
  export * from './getClickThroughRateResponse';
12
- export * from './getConversationRateResponse';
23
+ export * from './getConversionRateResponse';
13
24
  export * from './getNoClickRateResponse';
14
25
  export * from './getNoResultsRateResponse';
26
+ export * from './getPurchaseRateResponse';
27
+ export * from './getRevenue';
15
28
  export * from './getSearchesCountResponse';
16
29
  export * from './getSearchesNoClicksResponse';
17
30
  export * from './getSearchesNoResultsResponse';
@@ -27,20 +40,19 @@ export * from './getTopFiltersNoResultsValues';
27
40
  export * from './getTopHitsResponse';
28
41
  export * from './getTopSearchesResponse';
29
42
  export * from './getUsersCountResponse';
30
- export * from './noClickRateEvent';
31
- export * from './noResultsRateEvent';
43
+ export * from './operator';
32
44
  export * from './orderBy';
33
- export * from './searchEvent';
34
- export * from './searchNoClickEvent';
35
- export * from './searchNoResultEvent';
36
45
  export * from './topCountry';
37
46
  export * from './topHit';
38
47
  export * from './topHitWithAnalytics';
48
+ export * from './topHitWithRevenueAnalytics';
39
49
  export * from './topHitsResponse';
40
50
  export * from './topHitsResponseWithAnalytics';
51
+ export * from './topHitsResponseWithRevenueAnalytics';
41
52
  export * from './topSearch';
42
53
  export * from './topSearchWithAnalytics';
54
+ export * from './topSearchWithRevenueAnalytics';
43
55
  export * from './topSearchesResponse';
44
56
  export * from './topSearchesResponseWithAnalytics';
45
- export * from './userWithDate';
57
+ export * from './topSearchesResponseWithRevenueAnalytics';
46
58
  export * from './clientMethodProps';
@@ -0,0 +1,6 @@
1
+ // 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.
2
+
3
+ /**
4
+ * Character that characterizes how the filter is applied. For example, for a facet filter `facet:value`, `:` is the operator. For a numeric filter `count>50`, `>` is the operator.
5
+ */
6
+ export type Operator = ':' | '!=' | '<' | '<=' | '=' | '>' | '>=';
package/model/orderBy.ts CHANGED
@@ -1,7 +1,7 @@
1
1
  // 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.
2
2
 
3
3
  /**
4
- * Method for ordering results. `clickThroughRate`, `conversionRate` and `averageClickPosition` are only available if the `clickAnalytics` parameter is `true`.
4
+ * Attribute by which to order the response items. If the `clickAnalytics` parameter is false, only `searchCount` is available.
5
5
  */
6
6
  export type OrderBy =
7
7
  | 'averageClickPosition'
@@ -2,7 +2,7 @@
2
2
 
3
3
  export type TopCountry = {
4
4
  /**
5
- * Country.
5
+ * Country code.
6
6
  */
7
7
  country: string;
8
8
 
package/model/topHit.ts CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  export type TopHit = {
4
4
  /**
5
- * Hit.
5
+ * Object ID of a record that\'s returned as a search result.
6
6
  */
7
7
  hit: string;
8
8
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  export type TopHitWithAnalytics = {
4
4
  /**
5
- * Hit.
5
+ * Object ID of a record that\'s returned as a search result.
6
6
  */
7
7
  hit: string;
8
8
 
@@ -12,27 +12,27 @@ export type TopHitWithAnalytics = {
12
12
  count: number;
13
13
 
14
14
  /**
15
- * [Click-through rate (CTR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate).
15
+ * 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.
16
16
  */
17
- clickThroughRate: number;
17
+ clickThroughRate: number | null;
18
18
 
19
19
  /**
20
- * [Conversion rate (CR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#conversion-rate).
20
+ * 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.
21
21
  */
22
- conversionRate: number;
22
+ conversionRate: number | null;
23
23
 
24
24
  /**
25
- * Number of tracked searches. This is the number of search requests where the `clickAnalytics` parameter is `true`.
25
+ * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
26
26
  */
27
- trackedSearchCount: number;
27
+ trackedHitCount: number;
28
28
 
29
29
  /**
30
- * Number of click events.
30
+ * Number of clicks associated with this search.
31
31
  */
32
32
  clickCount: number;
33
33
 
34
34
  /**
35
- * Number of converted clicks.
35
+ * Number of conversions from this search.
36
36
  */
37
37
  conversionCount: number;
38
38
  };
@@ -0,0 +1,65 @@
1
+ // 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.
2
+
3
+ import type { CurrenciesValue } from './currenciesValue';
4
+
5
+ export type TopHitWithRevenueAnalytics = {
6
+ /**
7
+ * Object ID of a record that\'s returned as a search result.
8
+ */
9
+ hit: string;
10
+
11
+ /**
12
+ * Number of occurrences.
13
+ */
14
+ count: number;
15
+
16
+ /**
17
+ * 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.
18
+ */
19
+ clickThroughRate: number | null;
20
+
21
+ /**
22
+ * 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.
23
+ */
24
+ conversionRate: number | null;
25
+
26
+ /**
27
+ * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
28
+ */
29
+ trackedHitCount: number;
30
+
31
+ /**
32
+ * Number of clicks associated with this search.
33
+ */
34
+ clickCount: number;
35
+
36
+ /**
37
+ * Number of conversions from this search.
38
+ */
39
+ conversionCount: number;
40
+
41
+ /**
42
+ * 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.
43
+ */
44
+ addToCartRate: number | null;
45
+
46
+ /**
47
+ * Number of add-to-cart events from this search.
48
+ */
49
+ addToCartCount: number;
50
+
51
+ /**
52
+ * 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.
53
+ */
54
+ purchaseRate: number | null;
55
+
56
+ /**
57
+ * Number of purchase events from this search.
58
+ */
59
+ purchaseCount: number;
60
+
61
+ /**
62
+ * Revenue associated with this search, broken-down by currencies.
63
+ */
64
+ currencies: Record<string, CurrenciesValue>;
65
+ };
@@ -4,7 +4,7 @@ import type { TopHit } from './topHit';
4
4
 
5
5
  export type TopHitsResponse = {
6
6
  /**
7
- * Top hits.
7
+ * Most frequent search results.
8
8
  */
9
9
  hits: TopHit[];
10
10
  };
@@ -4,7 +4,7 @@ import type { TopHitWithAnalytics } from './topHitWithAnalytics';
4
4
 
5
5
  export type TopHitsResponseWithAnalytics = {
6
6
  /**
7
- * Top hits.
7
+ * Most frequent search results with click and conversion metrics.
8
8
  */
9
9
  hits: TopHitWithAnalytics[];
10
10
  };
@@ -0,0 +1,10 @@
1
+ // 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.
2
+
3
+ import type { TopHitWithRevenueAnalytics } from './topHitWithRevenueAnalytics';
4
+
5
+ export type TopHitsResponseWithRevenueAnalytics = {
6
+ /**
7
+ * Most frequent search results with click, conversion, and revenue metrics.
8
+ */
9
+ hits: TopHitWithRevenueAnalytics[];
10
+ };
@@ -2,17 +2,17 @@
2
2
 
3
3
  export type TopSearch = {
4
4
  /**
5
- * User query.
5
+ * Search query.
6
6
  */
7
7
  search: string;
8
8
 
9
9
  /**
10
- * Number of tracked _and_ untracked searches (where the `clickAnalytics` parameter isn\'t `true`).
10
+ * Number of searches.
11
11
  */
12
12
  count: number;
13
13
 
14
14
  /**
15
- * Number of hits the search query matched.
15
+ * Number of results (hits).
16
16
  */
17
17
  nbHits: number;
18
18
  };
@@ -1,48 +1,55 @@
1
1
  // 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.
2
2
 
3
+ import type { ClickPositionsInner } from './clickPositionsInner';
4
+
3
5
  export type TopSearchWithAnalytics = {
4
6
  /**
5
- * User query.
7
+ * Search query.
6
8
  */
7
9
  search: string;
8
10
 
9
11
  /**
10
- * Number of tracked _and_ untracked searches (where the `clickAnalytics` parameter isn\'t `true`).
12
+ * Number of searches.
11
13
  */
12
14
  count: number;
13
15
 
14
16
  /**
15
- * [Click-through rate (CTR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate).
17
+ * 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.
18
+ */
19
+ clickThroughRate: number | null;
20
+
21
+ /**
22
+ * 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.
16
23
  */
17
- clickThroughRate: number;
24
+ averageClickPosition: number | null;
18
25
 
19
26
  /**
20
- * Average [position](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-position) of clicked search result.
27
+ * List of positions in the search results and clicks associated with this search.
21
28
  */
22
- averageClickPosition: number;
29
+ clickPositions: ClickPositionsInner[];
23
30
 
24
31
  /**
25
- * [Conversion rate (CR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#conversion-rate).
32
+ * 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
33
  */
27
- conversionRate: number;
34
+ conversionRate: number | null;
28
35
 
29
36
  /**
30
- * Number of tracked searches. This is the number of search requests where the `clickAnalytics` parameter is `true`.
37
+ * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
31
38
  */
32
39
  trackedSearchCount: number;
33
40
 
34
41
  /**
35
- * Number of click events.
42
+ * Number of clicks associated with this search.
36
43
  */
37
44
  clickCount: number;
38
45
 
39
46
  /**
40
- * Number of converted clicks.
47
+ * Number of conversions from this search.
41
48
  */
42
49
  conversionCount: number;
43
50
 
44
51
  /**
45
- * Number of hits the search query matched.
52
+ * Number of results (hits).
46
53
  */
47
54
  nbHits: number;
48
55
  };
@@ -0,0 +1,81 @@
1
+ // 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.
2
+
3
+ import type { ClickPositionsInner } from './clickPositionsInner';
4
+ import type { CurrenciesValue } from './currenciesValue';
5
+
6
+ export type TopSearchWithRevenueAnalytics = {
7
+ /**
8
+ * Search query.
9
+ */
10
+ search: string;
11
+
12
+ /**
13
+ * Number of searches.
14
+ */
15
+ count: number;
16
+
17
+ /**
18
+ * 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.
19
+ */
20
+ clickThroughRate: number | null;
21
+
22
+ /**
23
+ * 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.
24
+ */
25
+ averageClickPosition: number | null;
26
+
27
+ /**
28
+ * List of positions in the search results and clicks associated with this search.
29
+ */
30
+ clickPositions: ClickPositionsInner[];
31
+
32
+ /**
33
+ * 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.
34
+ */
35
+ conversionRate: number | null;
36
+
37
+ /**
38
+ * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
39
+ */
40
+ trackedSearchCount: number;
41
+
42
+ /**
43
+ * Number of clicks associated with this search.
44
+ */
45
+ clickCount: number;
46
+
47
+ /**
48
+ * Number of conversions from this search.
49
+ */
50
+ conversionCount: number;
51
+
52
+ /**
53
+ * Number of results (hits).
54
+ */
55
+ nbHits: number;
56
+
57
+ /**
58
+ * Revenue associated with this search, broken-down by currencies.
59
+ */
60
+ currencies: Record<string, CurrenciesValue>;
61
+
62
+ /**
63
+ * 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.
64
+ */
65
+ addToCartRate: number | null;
66
+
67
+ /**
68
+ * Number of add-to-cart events from this search.
69
+ */
70
+ addToCartCount: number;
71
+
72
+ /**
73
+ * 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.
74
+ */
75
+ purchaseRate: number | null;
76
+
77
+ /**
78
+ * Number of purchase events from this search.
79
+ */
80
+ purchaseCount: number;
81
+ };
@@ -4,7 +4,7 @@ import type { TopSearch } from './topSearch';
4
4
 
5
5
  export type TopSearchesResponse = {
6
6
  /**
7
- * Top searches with their hits count.
7
+ * Most popular searches and their number of search results (hits).
8
8
  */
9
9
  searches: TopSearch[];
10
10
  };
@@ -4,7 +4,7 @@ import type { TopSearchWithAnalytics } from './topSearchWithAnalytics';
4
4
 
5
5
  export type TopSearchesResponseWithAnalytics = {
6
6
  /**
7
- * Top searches with their hits count and analytics.
7
+ * Most popular searches and their associated click and conversion metrics.
8
8
  */
9
9
  searches: TopSearchWithAnalytics[];
10
10
  };
@@ -0,0 +1,10 @@
1
+ // 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.
2
+
3
+ import type { TopSearchWithRevenueAnalytics } from './topSearchWithRevenueAnalytics';
4
+
5
+ export type TopSearchesResponseWithRevenueAnalytics = {
6
+ /**
7
+ * Most popular searches, including their click and revenue metrics.
8
+ */
9
+ searches: TopSearchWithRevenueAnalytics[];
10
+ };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@algolia/client-analytics",
3
- "version": "5.0.0-alpha.98",
3
+ "version": "5.0.0-beta.1",
4
4
  "description": "JavaScript client for client-analytics",
5
5
  "repository": "algolia/algoliasearch-client-javascript",
6
6
  "license": "MIT",
@@ -39,14 +39,14 @@
39
39
  "clean": "rm -rf ./dist || true"
40
40
  },
41
41
  "dependencies": {
42
- "@algolia/client-common": "5.0.0-alpha.99",
43
- "@algolia/requester-browser-xhr": "5.0.0-alpha.99",
44
- "@algolia/requester-node-http": "5.0.0-alpha.99"
42
+ "@algolia/client-common": "5.0.0-beta.1",
43
+ "@algolia/requester-browser-xhr": "5.0.0-beta.1",
44
+ "@algolia/requester-node-http": "5.0.0-beta.1"
45
45
  },
46
46
  "devDependencies": {
47
- "@types/node": "20.11.5",
48
- "rollup": "4.9.5",
49
- "typescript": "5.3.3"
47
+ "@types/node": "20.12.7",
48
+ "rollup": "4.14.2",
49
+ "typescript": "5.4.5"
50
50
  },
51
51
  "engines": {
52
52
  "node": ">= 14.0.0"
@@ -1,15 +0,0 @@
1
- export type AverageClickEvent = {
2
- /**
3
- * Average count of all click events.
4
- */
5
- average: number;
6
- /**
7
- * Number of click events.
8
- */
9
- clickCount: number;
10
- /**
11
- * Date of the event in the format YYYY-MM-DD.
12
- */
13
- date: string;
14
- };
15
- //# sourceMappingURL=averageClickEvent.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"averageClickEvent.d.ts","sourceRoot":"","sources":["../../model/averageClickEvent.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd,CAAC"}
@@ -1,11 +0,0 @@
1
- export type ClickPosition = {
2
- /**
3
- * Range of positions with the following pattern: - For positions 1 to 10, the number of click events are shown for each position - For positions 11 to 20, all click events are grouped - For positions 21 and up, all click events are grouped.
4
- */
5
- position: number[];
6
- /**
7
- * Number of click events.
8
- */
9
- clickCount: number;
10
- };
11
- //# sourceMappingURL=clickPosition.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"clickPosition.d.ts","sourceRoot":"","sources":["../../model/clickPosition.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,aAAa,GAAG;IAC1B;;OAEG;IACH,QAAQ,EAAE,MAAM,EAAE,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC"}
@@ -1,19 +0,0 @@
1
- export type ClickThroughRateEvent = {
2
- /**
3
- * [Click-through rate (CTR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate).
4
- */
5
- rate: number;
6
- /**
7
- * Number of click events.
8
- */
9
- clickCount: number;
10
- /**
11
- * Number of tracked searches. This is the number of search requests where the `clickAnalytics` parameter is `true`.
12
- */
13
- trackedSearchCount: number;
14
- /**
15
- * Date of the event in the format YYYY-MM-DD.
16
- */
17
- date: string;
18
- };
19
- //# sourceMappingURL=clickThroughRateEvent.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"clickThroughRateEvent.d.ts","sourceRoot":"","sources":["../../model/clickThroughRateEvent.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd,CAAC"}
@@ -1,19 +0,0 @@
1
- export type ConversionRateEvent = {
2
- /**
3
- * [Click-through rate (CTR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate).
4
- */
5
- rate: number;
6
- /**
7
- * Number of tracked searches. This is the number of search requests where the `clickAnalytics` parameter is `true`.
8
- */
9
- trackedSearchCount: number;
10
- /**
11
- * Number of converted clicks.
12
- */
13
- conversionCount: number;
14
- /**
15
- * Date of the event in the format YYYY-MM-DD.
16
- */
17
- date: string;
18
- };
19
- //# sourceMappingURL=conversionRateEvent.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"conversionRateEvent.d.ts","sourceRoot":"","sources":["../../model/conversionRateEvent.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd,CAAC"}
@@ -1,20 +0,0 @@
1
- import type { ConversionRateEvent } from './conversionRateEvent';
2
- export type GetConversationRateResponse = {
3
- /**
4
- * [Click-through rate (CTR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate).
5
- */
6
- rate: number;
7
- /**
8
- * Number of tracked searches. This is the number of search requests where the `clickAnalytics` parameter is `true`.
9
- */
10
- trackedSearchCount: number;
11
- /**
12
- * Number of converted clicks.
13
- */
14
- conversionCount: number;
15
- /**
16
- * Conversion events.
17
- */
18
- dates: ConversionRateEvent[];
19
- };
20
- //# sourceMappingURL=getConversationRateResponse.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"getConversationRateResponse.d.ts","sourceRoot":"","sources":["../../model/getConversationRateResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAEjE,MAAM,MAAM,2BAA2B,GAAG;IACxC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,KAAK,EAAE,mBAAmB,EAAE,CAAC;CAC9B,CAAC"}
@@ -1,19 +0,0 @@
1
- export type NoClickRateEvent = {
2
- /**
3
- * [Click-through rate (CTR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate).
4
- */
5
- rate: number;
6
- /**
7
- * Number of tracked _and_ untracked searches (where the `clickAnalytics` parameter isn\'t `true`).
8
- */
9
- count: number;
10
- /**
11
- * Number of click events.
12
- */
13
- noClickCount: number;
14
- /**
15
- * Date of the event in the format YYYY-MM-DD.
16
- */
17
- date: string;
18
- };
19
- //# sourceMappingURL=noClickRateEvent.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"noClickRateEvent.d.ts","sourceRoot":"","sources":["../../model/noClickRateEvent.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd,CAAC"}
@@ -1,19 +0,0 @@
1
- export type NoResultsRateEvent = {
2
- /**
3
- * Date of the event in the format YYYY-MM-DD.
4
- */
5
- date: string;
6
- /**
7
- * Number of occurences.
8
- */
9
- noResultCount: number;
10
- /**
11
- * Number of tracked _and_ untracked searches (where the `clickAnalytics` parameter isn\'t `true`).
12
- */
13
- count: number;
14
- /**
15
- * [Click-through rate (CTR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate).
16
- */
17
- rate: number;
18
- };
19
- //# sourceMappingURL=noResultsRateEvent.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"noResultsRateEvent.d.ts","sourceRoot":"","sources":["../../model/noResultsRateEvent.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd,CAAC"}
@@ -1,11 +0,0 @@
1
- export type SearchEvent = {
2
- /**
3
- * Date of the event in the format YYYY-MM-DD.
4
- */
5
- date: string;
6
- /**
7
- * Number of occurrences.
8
- */
9
- count: number;
10
- };
11
- //# sourceMappingURL=searchEvent.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"searchEvent.d.ts","sourceRoot":"","sources":["../../model/searchEvent.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,WAAW,GAAG;IACxB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC"}