@algolia/client-analytics 5.0.0-alpha.99 → 5.0.0-beta.1

package/dist/model/getTopFilterForAttribute.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getTopFilterForAttribute.d.ts","sourceRoot":"","sources":["../../model/getTopFilterForAttribute.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC"}
+{"version":3,"file":"getTopFilterForAttribute.d.ts","sourceRoot":"","sources":["../../model/getTopFilterForAttribute.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAE3C,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB,QAAQ,EAAE,QAAQ,CAAC;IAEnB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC"}

package/dist/model/getTopFiltersNoResultsResponse.d.ts

@@ -1,8 +1,8 @@
 import type { GetTopFiltersNoResultsValues } from './getTopFiltersNoResultsValues';
 export type GetTopFiltersNoResultsResponse = {
     /**
-     * Filters with no results.
+     * Filters for searches without any results. If null, the search term specified with the `search` parameter is not a search without results, or the `search` parameter is absent from the request.
      */
-    values: GetTopFiltersNoResultsValues[];
+    values: GetTopFiltersNoResultsValues[] | null;
 };
 //# sourceMappingURL=getTopFiltersNoResultsResponse.d.ts.map

package/dist/model/getTopFiltersNoResultsResponse.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getTopFiltersNoResultsResponse.d.ts","sourceRoot":"","sources":["../../model/getTopFiltersNoResultsResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,gCAAgC,CAAC;AAEnF,MAAM,MAAM,8BAA8B,GAAG;IAC3C;;OAEG;IACH,MAAM,EAAE,4BAA4B,EAAE,CAAC;CACxC,CAAC"}
+{"version":3,"file":"getTopFiltersNoResultsResponse.d.ts","sourceRoot":"","sources":["../../model/getTopFiltersNoResultsResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,gCAAgC,CAAC;AAEnF,MAAM,MAAM,8BAA8B,GAAG;IAC3C;;OAEG;IACH,MAAM,EAAE,4BAA4B,EAAE,GAAG,IAAI,CAAC;CAC/C,CAAC"}

package/dist/model/getTopFiltersNoResultsValue.d.ts

@@ -1,12 +1,10 @@
+import type { Operator } from './operator';
 export type GetTopFiltersNoResultsValue = {
     /**
      * Attribute name.
      */
     attribute: string;
-    /**
-     * Operator.
-     */
-    operator: string;
+    operator: Operator;
     /**
      * Attribute value.
      */

package/dist/model/getTopFiltersNoResultsValue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getTopFiltersNoResultsValue.d.ts","sourceRoot":"","sources":["../../model/getTopFiltersNoResultsValue.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,2BAA2B,GAAG;IACxC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC"}
+{"version":3,"file":"getTopFiltersNoResultsValue.d.ts","sourceRoot":"","sources":["../../model/getTopFiltersNoResultsValue.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAE3C,MAAM,MAAM,2BAA2B,GAAG;IACxC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB,QAAQ,EAAE,QAAQ,CAAC;IAEnB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC"}

package/dist/model/getTopHitsResponse.d.ts

@@ -1,4 +1,5 @@
 import type { TopHitsResponse } from './topHitsResponse';
 import type { TopHitsResponseWithAnalytics } from './topHitsResponseWithAnalytics';
-export type GetTopHitsResponse = TopHitsResponse | TopHitsResponseWithAnalytics;
+import type { TopHitsResponseWithRevenueAnalytics } from './topHitsResponseWithRevenueAnalytics';
+export type GetTopHitsResponse = TopHitsResponse | TopHitsResponseWithAnalytics | TopHitsResponseWithRevenueAnalytics;
 //# sourceMappingURL=getTopHitsResponse.d.ts.map

package/dist/model/getTopHitsResponse.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getTopHitsResponse.d.ts","sourceRoot":"","sources":["../../model/getTopHitsResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,gCAAgC,CAAC;AAEnF,MAAM,MAAM,kBAAkB,GAAG,eAAe,GAAG,4BAA4B,CAAC"}
+{"version":3,"file":"getTopHitsResponse.d.ts","sourceRoot":"","sources":["../../model/getTopHitsResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,gCAAgC,CAAC;AACnF,OAAO,KAAK,EAAE,mCAAmC,EAAE,MAAM,uCAAuC,CAAC;AAEjG,MAAM,MAAM,kBAAkB,GAC1B,eAAe,GACf,4BAA4B,GAC5B,mCAAmC,CAAC"}

package/dist/model/getTopSearchesResponse.d.ts

@@ -1,4 +1,5 @@
 import type { TopSearchesResponse } from './topSearchesResponse';
 import type { TopSearchesResponseWithAnalytics } from './topSearchesResponseWithAnalytics';
-export type GetTopSearchesResponse = TopSearchesResponse | TopSearchesResponseWithAnalytics;
+import type { TopSearchesResponseWithRevenueAnalytics } from './topSearchesResponseWithRevenueAnalytics';
+export type GetTopSearchesResponse = TopSearchesResponse | TopSearchesResponseWithAnalytics | TopSearchesResponseWithRevenueAnalytics;
 //# sourceMappingURL=getTopSearchesResponse.d.ts.map

package/dist/model/getTopSearchesResponse.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getTopSearchesResponse.d.ts","sourceRoot":"","sources":["../../model/getTopSearchesResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACjE,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,oCAAoC,CAAC;AAE3F,MAAM,MAAM,sBAAsB,GAC9B,mBAAmB,GACnB,gCAAgC,CAAC"}
+{"version":3,"file":"getTopSearchesResponse.d.ts","sourceRoot":"","sources":["../../model/getTopSearchesResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACjE,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,oCAAoC,CAAC;AAC3F,OAAO,KAAK,EAAE,uCAAuC,EAAE,MAAM,2CAA2C,CAAC;AAEzG,MAAM,MAAM,sBAAsB,GAC9B,mBAAmB,GACnB,gCAAgC,GAChC,uCAAuC,CAAC"}

package/dist/model/getUsersCountResponse.d.ts

@@ -1,12 +1,12 @@
-import type { UserWithDate } from './userWithDate';
+import type { DailyUsers } from './dailyUsers';
 export type GetUsersCountResponse = {
     /**
-     * Number of occurrences.
+     * Number of unique users.
      */
     count: number;
     /**
-     * User count.
+     * Daily number of unique users.
      */
-    dates: UserWithDate[];
+    dates: DailyUsers[];
 };
 //# sourceMappingURL=getUsersCountResponse.d.ts.map

package/dist/model/getUsersCountResponse.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getUsersCountResponse.d.ts","sourceRoot":"","sources":["../../model/getUsersCountResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,EAAE,YAAY,EAAE,CAAC;CACvB,CAAC"}
+{"version":3,"file":"getUsersCountResponse.d.ts","sourceRoot":"","sources":["../../model/getUsersCountResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,EAAE,UAAU,EAAE,CAAC;CACrB,CAAC"}

package/dist/model/index.d.ts

@@ -1,15 +1,28 @@
-export * from './averageClickEvent';
-export * from './clickPosition';
-export * from './clickThroughRateEvent';
-export * from './conversionRateEvent';
+export * from './clickPositionsInner';
+export * from './currenciesValue';
+export * from './dailyAddToCartRates';
+export * from './dailyAverageClicks';
+export * from './dailyClickThroughRates';
+export * from './dailyConversionRates';
+export * from './dailyNoClickRates';
+export * from './dailyNoResultsRates';
+export * from './dailyPurchaseRates';
+export * from './dailyRevenue';
+export * from './dailySearches';
+export * from './dailySearchesNoClicks';
+export * from './dailySearchesNoResults';
+export * from './dailyUsers';
 export * from './direction';
 export * from './errorBase';
+export * from './getAddToCartRateResponse';
 export * from './getAverageClickPositionResponse';
 export * from './getClickPositionsResponse';
 export * from './getClickThroughRateResponse';
-export * from './getConversationRateResponse';
+export * from './getConversionRateResponse';
 export * from './getNoClickRateResponse';
 export * from './getNoResultsRateResponse';
+export * from './getPurchaseRateResponse';
+export * from './getRevenue';
 export * from './getSearchesCountResponse';
 export * from './getSearchesNoClicksResponse';
 export * from './getSearchesNoResultsResponse';
@@ -25,21 +38,20 @@ export * from './getTopFiltersNoResultsValues';
 export * from './getTopHitsResponse';
 export * from './getTopSearchesResponse';
 export * from './getUsersCountResponse';
-export * from './noClickRateEvent';
-export * from './noResultsRateEvent';
+export * from './operator';
 export * from './orderBy';
-export * from './searchEvent';
-export * from './searchNoClickEvent';
-export * from './searchNoResultEvent';
 export * from './topCountry';
 export * from './topHit';
 export * from './topHitWithAnalytics';
+export * from './topHitWithRevenueAnalytics';
 export * from './topHitsResponse';
 export * from './topHitsResponseWithAnalytics';
+export * from './topHitsResponseWithRevenueAnalytics';
 export * from './topSearch';
 export * from './topSearchWithAnalytics';
+export * from './topSearchWithRevenueAnalytics';
 export * from './topSearchesResponse';
 export * from './topSearchesResponseWithAnalytics';
-export * from './userWithDate';
+export * from './topSearchesResponseWithRevenueAnalytics';
 export * from './clientMethodProps';
 //# sourceMappingURL=index.d.ts.map

package/dist/model/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../model/index.ts"],"names":[],"mappings":"AAEA,cAAc,qBAAqB,CAAC;AACpC,cAAc,iBAAiB,CAAC;AAChC,cAAc,yBAAyB,CAAC;AACxC,cAAc,uBAAuB,CAAC;AACtC,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,mCAAmC,CAAC;AAClD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,0BAA0B,CAAC;AACzC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,qBAAqB,CAAC;AACpC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,yBAAyB,CAAC;AACxC,cAAc,kCAAkC,CAAC;AACjD,cAAc,4BAA4B,CAAC;AAC3C,cAAc,oCAAoC,CAAC;AACnD,cAAc,kCAAkC,CAAC;AACjD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,sBAAsB,CAAC;AACrC,cAAc,0BAA0B,CAAC;AACzC,cAAc,yBAAyB,CAAC;AACxC,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,WAAW,CAAC;AAC1B,cAAc,eAAe,CAAC;AAC9B,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,aAAa,CAAC;AAC5B,cAAc,0BAA0B,CAAC;AACzC,cAAc,uBAAuB,CAAC;AACtC,cAAc,oCAAoC,CAAC;AACnD,cAAc,gBAAgB,CAAC;AAC/B,cAAc,qBAAqB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../model/index.ts"],"names":[],"mappings":"AAEA,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,sBAAsB,CAAC;AACrC,cAAc,0BAA0B,CAAC;AACzC,cAAc,wBAAwB,CAAC;AACvC,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AACtC,cAAc,sBAAsB,CAAC;AACrC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,yBAAyB,CAAC;AACxC,cAAc,0BAA0B,CAAC;AACzC,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,4BAA4B,CAAC;AAC3C,cAAc,mCAAmC,CAAC;AAClD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,0BAA0B,CAAC;AACzC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,cAAc,CAAC;AAC7B,cAAc,4BAA4B,CAAC;AAC3C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,qBAAqB,CAAC;AACpC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,yBAAyB,CAAC;AACxC,cAAc,kCAAkC,CAAC;AACjD,cAAc,4BAA4B,CAAC;AAC3C,cAAc,oCAAoC,CAAC;AACnD,cAAc,kCAAkC,CAAC;AACjD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,sBAAsB,CAAC;AACrC,cAAc,0BAA0B,CAAC;AACzC,cAAc,yBAAyB,CAAC;AACxC,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,uBAAuB,CAAC;AACtC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,mBAAmB,CAAC;AAClC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,uCAAuC,CAAC;AACtD,cAAc,aAAa,CAAC;AAC5B,cAAc,0BAA0B,CAAC;AACzC,cAAc,iCAAiC,CAAC;AAChD,cAAc,uBAAuB,CAAC;AACtC,cAAc,oCAAoC,CAAC;AACnD,cAAc,2CAA2C,CAAC;AAC1D,cAAc,qBAAqB,CAAC"}

package/dist/model/operator.d.ts

@@ -0,0 +1,5 @@
+/**
+ * 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.
+ */
+export type Operator = ':' | '!=' | '<' | '<=' | '=' | '>' | '>=';
+//# sourceMappingURL=operator.d.ts.map

package/dist/model/operator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"operator.d.ts","sourceRoot":"","sources":["../../model/operator.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,GAAG,GAAG,IAAI,GAAG,GAAG,GAAG,IAAI,GAAG,GAAG,GAAG,GAAG,GAAG,IAAI,CAAC"}

package/dist/model/orderBy.d.ts

@@ -1,5 +1,5 @@
 /**
- * Method for ordering results. `clickThroughRate`, `conversionRate` and `averageClickPosition` are only available if the `clickAnalytics` parameter is `true`.
+ * Attribute by which to order the response items.  If the `clickAnalytics` parameter is false, only `searchCount` is available.
  */
 export type OrderBy = 'averageClickPosition' | 'clickThroughRate' | 'conversionRate' | 'searchCount';
 //# sourceMappingURL=orderBy.d.ts.map

package/dist/model/topCountry.d.ts

@@ -1,6 +1,6 @@
 export type TopCountry = {
     /**
-     * Country.
+     * Country code.
      */
     country: string;
     /**

package/dist/model/topHit.d.ts

@@ -1,6 +1,6 @@
 export type TopHit = {
     /**
-     * Hit.
+     * Object ID of a record that\'s returned as a search result.
      */
     hit: string;
     /**

package/dist/model/topHitWithAnalytics.d.ts

@@ -1,6 +1,6 @@
 export type TopHitWithAnalytics = {
     /**
-     * Hit.
+     * Object ID of a record that\'s returned as a search result.
      */
     hit: string;
     /**
@@ -8,23 +8,23 @@ export type TopHitWithAnalytics = {
      */
     count: number;
     /**
-     * [Click-through rate (CTR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate).
+     * 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.
      */
-    clickThroughRate: number;
+    clickThroughRate: number | null;
     /**
-     * [Conversion rate (CR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#conversion-rate).
+     * 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.
      */
-    conversionRate: number;
+    conversionRate: number | null;
     /**
-     * Number of tracked searches. This is the number of search requests where the `clickAnalytics` parameter is `true`.
+     * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
      */
-    trackedSearchCount: number;
+    trackedHitCount: number;
     /**
-     * Number of click events.
+     * Number of clicks associated with this search.
      */
     clickCount: number;
     /**
-     * Number of converted clicks.
+     * Number of conversions from this search.
      */
     conversionCount: number;
 };

package/dist/model/topHitWithAnalytics.d.ts.map

@@ -1 +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,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"}
+{"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"}

package/dist/model/topHitWithRevenueAnalytics.d.ts

@@ -0,0 +1,52 @@
+import type { CurrenciesValue } from './currenciesValue';
+export type TopHitWithRevenueAnalytics = {
+    /**
+     * Object ID of a record that\'s returned as a search result.
+     */
+    hit: string;
+    /**
+     * Number of occurrences.
+     */
+    count: number;
+    /**
+     * 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.
+     */
+    clickThroughRate: number | null;
+    /**
+     * 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.
+     */
+    conversionRate: number | null;
+    /**
+     * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
+     */
+    trackedHitCount: number;
+    /**
+     * Number of clicks associated with this search.
+     */
+    clickCount: number;
+    /**
+     * Number of conversions from this search.
+     */
+    conversionCount: number;
+    /**
+     * 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.
+     */
+    addToCartRate: number | null;
+    /**
+     * Number of add-to-cart events from this search.
+     */
+    addToCartCount: number;
+    /**
+     * 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.
+     */
+    purchaseRate: number | null;
+    /**
+     * Number of purchase events from this search.
+     */
+    purchaseCount: number;
+    /**
+     * Revenue associated with this search, broken-down by currencies.
+     */
+    currencies: Record<string, CurrenciesValue>;
+};
+//# sourceMappingURL=topHitWithRevenueAnalytics.d.ts.map

package/dist/model/topHitWithRevenueAnalytics.d.ts.map

@@ -0,0 +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"}

package/dist/model/topHitsResponse.d.ts

@@ -1,7 +1,7 @@
 import type { TopHit } from './topHit';
 export type TopHitsResponse = {
     /**
-     * Top hits.
+     * Most frequent search results.
      */
     hits: TopHit[];
 };

package/dist/model/topHitsResponseWithAnalytics.d.ts

@@ -1,7 +1,7 @@
 import type { TopHitWithAnalytics } from './topHitWithAnalytics';
 export type TopHitsResponseWithAnalytics = {
     /**
-     * Top hits.
+     * Most frequent search results with click and conversion metrics.
      */
     hits: TopHitWithAnalytics[];
 };

package/dist/model/topHitsResponseWithRevenueAnalytics.d.ts

@@ -0,0 +1,8 @@
+import type { TopHitWithRevenueAnalytics } from './topHitWithRevenueAnalytics';
+export type TopHitsResponseWithRevenueAnalytics = {
+    /**
+     * Most frequent search results with click, conversion, and revenue metrics.
+     */
+    hits: TopHitWithRevenueAnalytics[];
+};
+//# sourceMappingURL=topHitsResponseWithRevenueAnalytics.d.ts.map

package/dist/model/topHitsResponseWithRevenueAnalytics.d.ts.map

@@ -0,0 +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"}

package/dist/model/topSearch.d.ts

@@ -1,14 +1,14 @@
 export type TopSearch = {
     /**
-     * User query.
+     * Search query.
      */
     search: string;
     /**
-     * Number of tracked _and_ untracked searches (where the `clickAnalytics` parameter isn\'t `true`).
+     * Number of searches.
      */
     count: number;
     /**
-     * Number of hits the search query matched.
+     * Number of results (hits).
      */
     nbHits: number;
 };

package/dist/model/topSearchWithAnalytics.d.ts

@@ -1,38 +1,43 @@
+import type { ClickPositionsInner } from './clickPositionsInner';
 export type TopSearchWithAnalytics = {
     /**
-     * User query.
+     * Search query.
      */
     search: string;
     /**
-     * Number of tracked _and_ untracked searches (where the `clickAnalytics` parameter isn\'t `true`).
+     * Number of searches.
      */
     count: number;
     /**
-     * [Click-through rate (CTR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate).
+     * 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.
      */
-    clickThroughRate: number;
+    clickThroughRate: number | null;
     /**
-     * Average [position](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-position) of clicked search result.
+     * 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.
      */
-    averageClickPosition: number;
+    averageClickPosition: number | null;
     /**
-     * [Conversion rate (CR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#conversion-rate).
+     * List of positions in the search results and clicks associated with this search.
      */
-    conversionRate: number;
+    clickPositions: ClickPositionsInner[];
     /**
-     * Number of tracked searches. This is the number of search requests where the `clickAnalytics` parameter is `true`.
+     * 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.
+     */
+    conversionRate: number | null;
+    /**
+     * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
      */
     trackedSearchCount: number;
     /**
-     * Number of click events.
+     * Number of clicks associated with this search.
      */
     clickCount: number;
     /**
-     * Number of converted clicks.
+     * Number of conversions from this search.
      */
     conversionCount: number;
     /**
-     * Number of hits the search query matched.
+     * Number of results (hits).
      */
     nbHits: number;
 };

package/dist/model/topSearchWithAnalytics.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"topSearchWithAnalytics.d.ts","sourceRoot":"","sources":["../../model/topSearchWithAnalytics.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,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"}
+{"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"}

package/dist/model/topSearchWithRevenueAnalytics.d.ts

@@ -0,0 +1,65 @@
+import type { ClickPositionsInner } from './clickPositionsInner';
+import type { CurrenciesValue } from './currenciesValue';
+export type TopSearchWithRevenueAnalytics = {
+    /**
+     * Search query.
+     */
+    search: string;
+    /**
+     * Number of searches.
+     */
+    count: number;
+    /**
+     * 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.
+     */
+    clickThroughRate: number | null;
+    /**
+     * 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.
+     */
+    averageClickPosition: number | null;
+    /**
+     * List of positions in the search results and clicks associated with this search.
+     */
+    clickPositions: ClickPositionsInner[];
+    /**
+     * 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.
+     */
+    conversionRate: number | null;
+    /**
+     * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
+     */
+    trackedSearchCount: number;
+    /**
+     * Number of clicks associated with this search.
+     */
+    clickCount: number;
+    /**
+     * Number of conversions from this search.
+     */
+    conversionCount: number;
+    /**
+     * Number of results (hits).
+     */
+    nbHits: number;
+    /**
+     * Revenue associated with this search, broken-down by currencies.
+     */
+    currencies: Record<string, CurrenciesValue>;
+    /**
+     * 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.
+     */
+    addToCartRate: number | null;
+    /**
+     * Number of add-to-cart events from this search.
+     */
+    addToCartCount: number;
+    /**
+     * 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.
+     */
+    purchaseRate: number | null;
+    /**
+     * Number of purchase events from this search.
+     */
+    purchaseCount: number;
+};
+//# sourceMappingURL=topSearchWithRevenueAnalytics.d.ts.map

package/dist/model/topSearchWithRevenueAnalytics.d.ts.map

@@ -0,0 +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"}

package/dist/model/topSearchesResponse.d.ts

@@ -1,7 +1,7 @@
 import type { TopSearch } from './topSearch';
 export type TopSearchesResponse = {
     /**
-     * Top searches with their hits count.
+     * Most popular searches and their number of search results (hits).
      */
     searches: TopSearch[];
 };

package/dist/model/topSearchesResponseWithAnalytics.d.ts

@@ -1,7 +1,7 @@
 import type { TopSearchWithAnalytics } from './topSearchWithAnalytics';
 export type TopSearchesResponseWithAnalytics = {
     /**
-     * Top searches with their hits count and analytics.
+     * Most popular searches and their associated click and conversion metrics.
      */
     searches: TopSearchWithAnalytics[];
 };

package/dist/model/topSearchesResponseWithRevenueAnalytics.d.ts

@@ -0,0 +1,8 @@
+import type { TopSearchWithRevenueAnalytics } from './topSearchWithRevenueAnalytics';
+export type TopSearchesResponseWithRevenueAnalytics = {
+    /**
+     * Most popular searches, including their click and revenue metrics.
+     */
+    searches: TopSearchWithRevenueAnalytics[];
+};
+//# sourceMappingURL=topSearchesResponseWithRevenueAnalytics.d.ts.map

package/dist/model/topSearchesResponseWithRevenueAnalytics.d.ts.map

@@ -0,0 +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"}