@algolia/client-analytics 5.0.0-alpha.8 → 5.0.0-alpha.80

package/dist/model/topSearchWithAnalytics.d.ts

@@ -1,39 +1,39 @@
-export declare type TopSearchWithAnalytics = {
-    /**
-     * The search query.
-     */
-    search: string;
-    /**
-     * The number of occurrences.
-     */
-    count: number;
-    /**
-     * The click-through rate.
-     */
-    clickThroughRate: number;
-    /**
-     * The average position of all the click count event.
-     */
-    averageClickPosition: number;
-    /**
-     * The conversion rate.
-     */
-    conversionRate: number;
-    /**
-     * The number of tracked search click.
-     */
-    trackedSearchCount: number;
-    /**
-     * The number of click event.
-     */
-    clickCount: number;
-    /**
-     * The number of converted clicks.
-     */
-    conversionCount: number;
-    /**
-     * Number of hits that the search query matched.
-     */
-    nbHits: number;
-};
+export type TopSearchWithAnalytics = {
+    /**
+     * User query.
+     */
+    search: string;
+    /**
+     * Number of tracked _and_ untracked searches (where the `clickAnalytics` parameter isn\'t `true`).
+     */
+    count: number;
+    /**
+     * [Click-through rate (CTR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate).
+     */
+    clickThroughRate: number;
+    /**
+     * Average [position](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-position) of clicked search result.
+     */
+    averageClickPosition: number;
+    /**
+     * [Conversion rate (CR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#conversion-rate).
+     */
+    conversionRate: number;
+    /**
+     * Number of tracked searches. This is the number of search requests where the `clickAnalytics` parameter is `true`.
+     */
+    trackedSearchCount: number;
+    /**
+     * Number of click events.
+     */
+    clickCount: number;
+    /**
+     * Number of converted clicks.
+     */
+    conversionCount: number;
+    /**
+     * Number of hits the search query matched.
+     */
+    nbHits: number;
+};
 //# sourceMappingURL=topSearchWithAnalytics.d.ts.map

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

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

package/dist/model/topSearchesResponse.d.ts

@@ -1,8 +1,8 @@
-import type { TopSearch } from './topSearch';
-export declare type TopSearchesResponse = {
-    /**
-     * A list of top searches with their count.
-     */
-    searches: TopSearch[];
-};
+import type { TopSearch } from './topSearch';
+export type TopSearchesResponse = {
+    /**
+     * Top searches with their hits count.
+     */
+    searches: TopSearch[];
+};
 //# sourceMappingURL=topSearchesResponse.d.ts.map

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

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

package/dist/model/topSearchesResponseWithAnalytics.d.ts

@@ -1,8 +1,8 @@
-import type { TopSearchWithAnalytics } from './topSearchWithAnalytics';
-export declare type TopSearchesResponseWithAnalytics = {
-    /**
-     * A list of top searches with their count and analytics.
-     */
-    searches: TopSearchWithAnalytics[];
-};
+import type { TopSearchWithAnalytics } from './topSearchWithAnalytics';
+export type TopSearchesResponseWithAnalytics = {
+    /**
+     * Top searches with their hits count and analytics.
+     */
+    searches: TopSearchWithAnalytics[];
+};
 //# sourceMappingURL=topSearchesResponseWithAnalytics.d.ts.map

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

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

package/dist/model/userWithDate.d.ts

@@ -1,11 +1,11 @@
-export declare type UserWithDate = {
-    /**
-     * Date of the event.
-     */
-    date: string;
-    /**
-     * The number of occurrences.
-     */
-    count: number;
-};
+export type UserWithDate = {
+    /**
+     * Date of the event in the format YYYY-MM-DD.
+     */
+    date: string;
+    /**
+     * Number of occurrences.
+     */
+    count: number;
+};
 //# sourceMappingURL=userWithDate.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"userWithDate.d.ts","sourceRoot":"","sources":["../../model/userWithDate.ts"],"names":[],"mappings":"AAEA,oBAAY,YAAY,GAAG;IACzB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC"}
+{"version":3,"file":"userWithDate.d.ts","sourceRoot":"","sources":["../../model/userWithDate.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,YAAY,GAAG;IACzB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC"}