@algolia/client-analytics 5.0.0-alpha.108 → 5.0.0-alpha.109

package/model/getClickThroughRateResponse.ts

@@ -1,25 +1,25 @@
 // 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.
 
-import type { ClickThroughRateEvent } from './clickThroughRateEvent';
+import type { DailyClickThroughRates } from './dailyClickThroughRates';
 
 export type GetClickThroughRateResponse = {
   /**
-   * [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.
    */
-  rate: number;
+  rate: number | null;
 
   /**
-   * Number of click events.
+   * Number of clicks associated with this search.
    */
   clickCount: number;
 
   /**
-   * 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 | null;
+  trackedSearchCount: number;
 
   /**
-   * Click-through rate events.
+   * Daily click-through rates.
    */
-  dates: ClickThroughRateEvent[];
+  dates: DailyClickThroughRates[];
 };

package/model/getConversionRateResponse.ts

@@ -0,0 +1,25 @@
+// 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.
+
+import type { DailyConversionRates } from './dailyConversionRates';
+
+export type GetConversionRateResponse = {
+  /**
+   * 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.
+   */
+  rate: number | null;
+
+  /**
+   * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
+   */
+  trackedSearchCount: number;
+
+  /**
+   * Number of conversions from this search.
+   */
+  conversionCount: number;
+
+  /**
+   * Daily conversion rates.
+   */
+  dates: DailyConversionRates[];
+};

package/model/getNoClickRateResponse.ts

@@ -1,25 +1,25 @@
 // 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.
 
-import type { NoClickRateEvent } from './noClickRateEvent';
+import type { DailyNoClickRates } from './dailyNoClickRates';
 
 export type GetNoClickRateResponse = {
   /**
-   * [Click-through rate (CTR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate).
+   * No click rate, calculated as number of tracked searches without any click divided by the number of tracked searches.
    */
   rate: number;
 
   /**
-   * Number of click events.
+   * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
    */
   count: number;
 
   /**
-   * Number of click events.
+   * Number of times this search was returned as a result without any click.
    */
   noClickCount: number;
 
   /**
-   * Overall count of searches without clicks plus a daily breakdown.
+   * Daily no click rates.
    */
-  dates: NoClickRateEvent[];
+  dates: DailyNoClickRates[];
 };

package/model/getNoResultsRateResponse.ts

@@ -1,25 +1,25 @@
 // 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.
 
-import type { NoResultsRateEvent } from './noResultsRateEvent';
+import type { DailyNoResultsRates } from './dailyNoResultsRates';
 
 export type GetNoResultsRateResponse = {
   /**
-   * [Click-through rate (CTR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate).
+   * No results rate, calculated as number of searches with zero results divided by the total number of searches.
    */
   rate: number;
 
   /**
-   * Number of occurrences.
+   * Number of searches.
    */
   count: number;
 
   /**
-   * Number of occurrences.
+   * Number of searches without any results.
    */
   noResultCount: number;
 
   /**
-   * Overall count of searches without results plus a daily breakdown.
+   * Daily no results rates.
    */
-  dates: NoResultsRateEvent[];
+  dates: DailyNoResultsRates[];
 };

package/model/getPurchaseRateResponse.ts

@@ -0,0 +1,25 @@
+// 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.
+
+import type { DailyPurchaseRates } from './dailyPurchaseRates';
+
+export type GetPurchaseRateResponse = {
+  /**
+   * 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.
+   */
+  rate: number | null;
+
+  /**
+   * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
+   */
+  trackedSearchCount: number;
+
+  /**
+   * Number of purchase events from this search.
+   */
+  purchaseCount: number;
+
+  /**
+   * Daily purchase rates.
+   */
+  dates: DailyPurchaseRates[];
+};

package/model/getRevenue.ts

@@ -0,0 +1,16 @@
+// 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.
+
+import type { CurrenciesValue } from './currenciesValue';
+import type { DailyRevenue } from './dailyRevenue';
+
+export type GetRevenue = {
+  /**
+   * Revenue associated with this search, broken-down by currencies.
+   */
+  currencies: Record<string, CurrenciesValue>;
+
+  /**
+   * Daily revenue.
+   */
+  dates: DailyRevenue[];
+};

package/model/getSearchesCountResponse.ts

@@ -1,6 +1,6 @@
 // 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.
 
-import type { SearchEvent } from './searchEvent';
+import type { DailySearches } from './dailySearches';
 
 export type GetSearchesCountResponse = {
   /**
@@ -9,7 +9,7 @@ export type GetSearchesCountResponse = {
   count: number;
 
   /**
-   * Search events with their associated dates and hit counts.
+   * Daily number of searches.
    */
-  dates: SearchEvent[];
+  dates: DailySearches[];
 };

package/model/getSearchesNoClicksResponse.ts

@@ -1,10 +1,10 @@
 // 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.
 
-import type { SearchNoClickEvent } from './searchNoClickEvent';
+import type { DailySearchesNoClicks } from './dailySearchesNoClicks';
 
 export type GetSearchesNoClicksResponse = {
   /**
-   * Searches with no clicks.
+   * Searches without any clicks.
    */
-  searches: SearchNoClickEvent[];
+  searches: DailySearchesNoClicks[];
 };

package/model/getSearchesNoResultsResponse.ts

@@ -1,10 +1,10 @@
 // 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.
 
-import type { SearchNoResultEvent } from './searchNoResultEvent';
+import type { DailySearchesNoResults } from './dailySearchesNoResults';
 
 export type GetSearchesNoResultsResponse = {
   /**
-   * Searches with no results.
+   * Searches without results.
    */
-  searches: SearchNoResultEvent[];
+  searches: DailySearchesNoResults[];
 };

package/model/getStatusResponse.ts

@@ -2,7 +2,7 @@
 
 export type GetStatusResponse = {
   /**
-   * Timestamp of the last update in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
+   * Timestamp of the last update in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format. If null, no update was performed yet.
    */
-  updatedAt: string;
+  updatedAt: string | null;
 };

package/model/getTopCountriesResponse.ts

@@ -4,7 +4,7 @@ import type { TopCountry } from './topCountry';
 
 export type GetTopCountriesResponse = {
   /**
-   * Countries.
+   * Countries and number of searches.
    */
   countries: TopCountry[];
 };

package/model/getTopFilterAttributesResponse.ts

@@ -4,7 +4,7 @@ import type { GetTopFilterAttribute } from './getTopFilterAttribute';
 
 export type GetTopFilterAttributesResponse = {
   /**
-   * Filterable attributes.
+   * Most frequent filters.
    */
   attributes: GetTopFilterAttribute[];
 };

package/model/getTopFilterForAttribute.ts

@@ -1,15 +1,14 @@
 // 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.
 
+import type { Operator } from './operator';
+
 export type GetTopFilterForAttribute = {
   /**
    * Attribute name.
    */
   attribute: string;
 
-  /**
-   * Operator.
-   */
-  operator: string;
+  operator: Operator;
 
   /**
    * Attribute value.

package/model/getTopFiltersNoResultsResponse.ts

@@ -4,7 +4,7 @@ import type { GetTopFiltersNoResultsValues } from './getTopFiltersNoResultsValue
 
 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;
 };

package/model/getTopFiltersNoResultsValue.ts

@@ -1,15 +1,14 @@
 // 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.
 
+import type { Operator } from './operator';
+
 export type GetTopFiltersNoResultsValue = {
   /**
    * Attribute name.
    */
   attribute: string;
 
-  /**
-   * Operator.
-   */
-  operator: string;
+  operator: Operator;
 
   /**
    * Attribute value.

package/model/getTopHitsResponse.ts

@@ -2,5 +2,9 @@
 
 import type { TopHitsResponse } from './topHitsResponse';
 import type { TopHitsResponseWithAnalytics } from './topHitsResponseWithAnalytics';
+import type { TopHitsResponseWithRevenueAnalytics } from './topHitsResponseWithRevenueAnalytics';
 
-export type GetTopHitsResponse = TopHitsResponse | TopHitsResponseWithAnalytics;
+export type GetTopHitsResponse =
+  | TopHitsResponse
+  | TopHitsResponseWithAnalytics
+  | TopHitsResponseWithRevenueAnalytics;

package/model/getTopSearchesResponse.ts

@@ -2,7 +2,9 @@
 
 import type { TopSearchesResponse } from './topSearchesResponse';
 import type { TopSearchesResponseWithAnalytics } from './topSearchesResponseWithAnalytics';
+import type { TopSearchesResponseWithRevenueAnalytics } from './topSearchesResponseWithRevenueAnalytics';
 
 export type GetTopSearchesResponse =
   | TopSearchesResponse
-  | TopSearchesResponseWithAnalytics;
+  | TopSearchesResponseWithAnalytics
+  | TopSearchesResponseWithRevenueAnalytics;

package/model/getUsersCountResponse.ts

@@ -1,15 +1,15 @@
 // 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.
 
-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[];
 };

package/model/index.ts

@@ -1,17 +1,30 @@
 // 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.
 
-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';
@@ -27,20 +40,19 @@ 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';

package/model/operator.ts

@@ -0,0 +1,6 @@
+// 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.
+
+/**
+ * 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 = ':' | '!=' | '<' | '<=' | '=' | '>' | '>=';

package/model/orderBy.ts

@@ -1,7 +1,7 @@
 // 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.
 
 /**
- * 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'

package/model/topCountry.ts

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

package/model/topHit.ts

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

package/model/topHitWithAnalytics.ts

@@ -2,7 +2,7 @@
 
 export type TopHitWithAnalytics = {
   /**
-   * Hit.
+   * Object ID of a record that\'s returned as a search result.
    */
   hit: string;
 
@@ -12,27 +12,27 @@ 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 | null;
+  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/model/topHitWithRevenueAnalytics.ts

@@ -0,0 +1,65 @@
+// 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.
+
+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>;
+};

package/model/topHitsResponse.ts

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

package/model/topHitsResponseWithAnalytics.ts

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

package/model/topHitsResponseWithRevenueAnalytics.ts

@@ -0,0 +1,10 @@
+// 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.
+
+import type { TopHitWithRevenueAnalytics } from './topHitWithRevenueAnalytics';
+
+export type TopHitsResponseWithRevenueAnalytics = {
+  /**
+   * Most frequent search results with click, conversion, and revenue metrics.
+   */
+  hits: TopHitWithRevenueAnalytics[];
+};

package/model/topSearch.ts

@@ -2,12 +2,12 @@
 
 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;