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

package/model/clientMethodProps.ts

@@ -67,6 +67,28 @@ export type CustomPutProps = {
   body?: Record<string, any>;
 };
 
+/**
+ * Properties for the `getAddToCartRate` method.
+ */
+export type GetAddToCartRateProps = {
+  /**
+   * Index name.
+   */
+  index: string;
+  /**
+   * Start date (`YYYY-MM-DD`) of the period to analyze.
+   */
+  startDate?: string;
+  /**
+   * End date (`YYYY-MM-DD`) of the period to analyze.
+   */
+  endDate?: string;
+  /**
+   * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+   */
+  tags?: string;
+};
+
 /**
  * Properties for the `getAverageClickPosition` method.
  */
@@ -84,7 +106,7 @@ export type GetAverageClickPositionProps = {
    */
   endDate?: string;
   /**
-   * Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
+   * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
    */
   tags?: string;
 };
@@ -106,7 +128,7 @@ export type GetClickPositionsProps = {
    */
   endDate?: string;
   /**
-   * Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
+   * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
    */
   tags?: string;
 };
@@ -128,15 +150,15 @@ export type GetClickThroughRateProps = {
    */
   endDate?: string;
   /**
-   * Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
+   * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
    */
   tags?: string;
 };
 
 /**
- * Properties for the `getConversationRate` method.
+ * Properties for the `getConversionRate` method.
  */
-export type GetConversationRateProps = {
+export type GetConversionRateProps = {
   /**
    * Index name.
    */
@@ -150,7 +172,7 @@ export type GetConversationRateProps = {
    */
   endDate?: string;
   /**
-   * Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
+   * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
    */
   tags?: string;
 };
@@ -172,7 +194,7 @@ export type GetNoClickRateProps = {
    */
   endDate?: string;
   /**
-   * Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
+   * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
    */
   tags?: string;
 };
@@ -194,7 +216,51 @@ export type GetNoResultsRateProps = {
    */
   endDate?: string;
   /**
-   * Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
+   * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+   */
+  tags?: string;
+};
+
+/**
+ * Properties for the `getPurchaseRate` method.
+ */
+export type GetPurchaseRateProps = {
+  /**
+   * Index name.
+   */
+  index: string;
+  /**
+   * Start date (`YYYY-MM-DD`) of the period to analyze.
+   */
+  startDate?: string;
+  /**
+   * End date (`YYYY-MM-DD`) of the period to analyze.
+   */
+  endDate?: string;
+  /**
+   * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+   */
+  tags?: string;
+};
+
+/**
+ * Properties for the `getRevenue` method.
+ */
+export type GetRevenueProps = {
+  /**
+   * Index name.
+   */
+  index: string;
+  /**
+   * Start date (`YYYY-MM-DD`) of the period to analyze.
+   */
+  startDate?: string;
+  /**
+   * End date (`YYYY-MM-DD`) of the period to analyze.
+   */
+  endDate?: string;
+  /**
+   * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
    */
   tags?: string;
 };
@@ -216,7 +282,7 @@ export type GetSearchesCountProps = {
    */
   endDate?: string;
   /**
-   * Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
+   * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
    */
   tags?: string;
 };
@@ -246,7 +312,7 @@ export type GetSearchesNoClicksProps = {
    */
   offset?: number;
   /**
-   * Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
+   * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
    */
   tags?: string;
 };
@@ -276,7 +342,7 @@ export type GetSearchesNoResultsProps = {
    */
   offset?: number;
   /**
-   * Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
+   * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
    */
   tags?: string;
 };
@@ -316,7 +382,7 @@ export type GetTopCountriesProps = {
    */
   offset?: number;
   /**
-   * Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
+   * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
    */
   tags?: string;
 };
@@ -330,7 +396,7 @@ export type GetTopFilterAttributesProps = {
    */
   index: string;
   /**
-   * User query.
+   * Search query.
    */
   search?: string;
   /**
@@ -350,7 +416,7 @@ export type GetTopFilterAttributesProps = {
    */
   offset?: number;
   /**
-   * Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
+   * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
    */
   tags?: string;
 };
@@ -368,7 +434,7 @@ export type GetTopFilterForAttributeProps = {
    */
   index: string;
   /**
-   * User query.
+   * Search query.
    */
   search?: string;
   /**
@@ -388,7 +454,7 @@ export type GetTopFilterForAttributeProps = {
    */
   offset?: number;
   /**
-   * Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
+   * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
    */
   tags?: string;
 };
@@ -402,7 +468,7 @@ export type GetTopFiltersNoResultsProps = {
    */
   index: string;
   /**
-   * User query.
+   * Search query.
    */
   search?: string;
   /**
@@ -422,7 +488,7 @@ export type GetTopFiltersNoResultsProps = {
    */
   offset?: number;
   /**
-   * Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
+   * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
    */
   tags?: string;
 };
@@ -436,13 +502,17 @@ export type GetTopHitsProps = {
    */
   index: string;
   /**
-   * User query.
+   * Search query.
    */
   search?: string;
   /**
-   * Whether to include [click and conversion](https://www.algolia.com/doc/guides/sending-events/getting-started/) rates for a search.
+   * Whether to include metrics related to click and conversion events in the response.
    */
   clickAnalytics?: boolean;
+  /**
+   * Whether to include revenue-related metrics in the response.  If true, metrics related to click and conversion events are also included in the response.
+   */
+  revenueAnalytics?: boolean;
   /**
    * Start date (`YYYY-MM-DD`) of the period to analyze.
    */
@@ -460,7 +530,7 @@ export type GetTopHitsProps = {
    */
   offset?: number;
   /**
-   * Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
+   * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
    */
   tags?: string;
 };
@@ -474,9 +544,13 @@ export type GetTopSearchesProps = {
    */
   index: string;
   /**
-   * Whether to include [click and conversion](https://www.algolia.com/doc/guides/sending-events/getting-started/) rates for a search.
+   * Whether to include metrics related to click and conversion events in the response.
    */
   clickAnalytics?: boolean;
+  /**
+   * Whether to include revenue-related metrics in the response.  If true, metrics related to click and conversion events are also included in the response.
+   */
+  revenueAnalytics?: boolean;
   /**
    * Start date (`YYYY-MM-DD`) of the period to analyze.
    */
@@ -486,7 +560,7 @@ export type GetTopSearchesProps = {
    */
   endDate?: string;
   /**
-   * Reorder the results.
+   * Attribute by which to order the response items.  If the `clickAnalytics` parameter is false, only `searchCount` is available.
    */
   orderBy?: OrderBy;
   /**
@@ -502,7 +576,7 @@ export type GetTopSearchesProps = {
    */
   offset?: number;
   /**
-   * Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
+   * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
    */
   tags?: string;
 };
@@ -524,7 +598,7 @@ export type GetUsersCountProps = {
    */
   endDate?: string;
   /**
-   * Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
+   * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
    */
   tags?: string;
 };

package/model/currenciesValue.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.
+
+/**
+ * Currency code.
+ */
+export type CurrenciesValue = {
+  /**
+   * Currency code.
+   */
+  currency?: string;
+
+  /**
+   * Revenue associated with this search in this currency.
+   */
+  revenue?: number;
+};

package/model/dailyAddToCartRates.ts

@@ -0,0 +1,23 @@
+// 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 type DailyAddToCartRates = {
+  /**
+   * 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.
+   */
+  rate: number | null;
+
+  /**
+   * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
+   */
+  trackedSearchCount: number;
+
+  /**
+   * Number of add-to-cart events from this search.
+   */
+  addToCartCount: number;
+
+  /**
+   * Date in the format YYYY-MM-DD.
+   */
+  date: string;
+};

package/model/dailyAverageClicks.ts

@@ -0,0 +1,18 @@
+// 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 type DailyAverageClicks = {
+  /**
+   * 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.
+   */
+  average: number | null;
+
+  /**
+   * Number of clicks associated with this search.
+   */
+  clickCount: number;
+
+  /**
+   * Date in the format YYYY-MM-DD.
+   */
+  date: string;
+};

package/model/dailyClickThroughRates.ts

@@ -0,0 +1,23 @@
+// 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 type DailyClickThroughRates = {
+  /**
+   * 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 | null;
+
+  /**
+   * Number of clicks associated with this search.
+   */
+  clickCount: number;
+
+  /**
+   * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
+   */
+  trackedSearchCount: number;
+
+  /**
+   * Date in the format YYYY-MM-DD.
+   */
+  date: string;
+};

package/model/dailyConversionRates.ts

@@ -0,0 +1,23 @@
+// 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 type DailyConversionRates = {
+  /**
+   * 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;
+
+  /**
+   * Date in the format YYYY-MM-DD.
+   */
+  date: string;
+};

package/model/dailyNoClickRates.ts

@@ -0,0 +1,23 @@
+// 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 type DailyNoClickRates = {
+  /**
+   * No click rate, calculated as number of tracked searches without any click divided by the number of tracked searches.
+   */
+  rate: number;
+
+  /**
+   * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
+   */
+  count: number;
+
+  /**
+   * Number of times this search was returned as a result without any click.
+   */
+  noClickCount: number;
+
+  /**
+   * Date in the format YYYY-MM-DD.
+   */
+  date: string;
+};

package/model/dailyNoResultsRates.ts

@@ -0,0 +1,23 @@
+// 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 type DailyNoResultsRates = {
+  /**
+   * Date in the format YYYY-MM-DD.
+   */
+  date: string;
+
+  /**
+   * Number of searches without any results.
+   */
+  noResultCount: number;
+
+  /**
+   * Number of searches.
+   */
+  count: number;
+
+  /**
+   * No results rate, calculated as number of searches with zero results divided by the total number of searches.
+   */
+  rate: number;
+};

package/model/dailyPurchaseRates.ts

@@ -0,0 +1,23 @@
+// 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 type DailyPurchaseRates = {
+  /**
+   * 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;
+
+  /**
+   * Date in the format YYYY-MM-DD.
+   */
+  date: string;
+};

package/model/dailyRevenue.ts

@@ -0,0 +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 { CurrenciesValue } from './currenciesValue';
+
+export type DailyRevenue = {
+  /**
+   * Revenue associated with this search, broken-down by currencies.
+   */
+  currencies: Record<string, CurrenciesValue>;
+
+  /**
+   * Date in the format YYYY-MM-DD.
+   */
+  date: string;
+};

package/model/{searchEvent.ts → dailySearches.ts}

@@ -1,8 +1,8 @@
 // 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 type SearchEvent = {
+export type DailySearches = {
   /**
-   * Date of the event in the format YYYY-MM-DD.
+   * Date in the format YYYY-MM-DD.
    */
   date: string;
 

package/model/{searchNoResultEvent.ts → dailySearchesNoClicks.ts}

@@ -1,13 +1,13 @@
 // 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 type SearchNoResultEvent = {
+export type DailySearchesNoClicks = {
   /**
-   * User query.
+   * Search query.
    */
   search: string;
 
   /**
-   * Number of occurrences.
+   * Number of tracked searches.
    */
   count: number;
 

package/model/{searchNoClickEvent.ts → dailySearchesNoResults.ts}

@@ -1,8 +1,8 @@
 // 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 type SearchNoClickEvent = {
+export type DailySearchesNoResults = {
   /**
-   * User query.
+   * Search query.
    */
   search: string;
 
@@ -12,7 +12,7 @@ export type SearchNoClickEvent = {
   count: number;
 
   /**
-   * Number of occurrences.
+   * Number of searches for this term with applied filters.
    */
   withFilterCount: number;
 };

package/model/{userWithDate.ts → dailyUsers.ts}

@@ -1,13 +1,13 @@
 // 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 type UserWithDate = {
+export type DailyUsers = {
   /**
-   * Date of the event in the format YYYY-MM-DD.
+   * Date in the format YYYY-MM-DD.
    */
   date: string;
 
   /**
-   * Number of occurrences.
+   * Number of unique users.
    */
   count: number;
 };

package/model/getAddToCartRateResponse.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 { DailyAddToCartRates } from './dailyAddToCartRates';
+
+export type GetAddToCartRateResponse = {
+  /**
+   * 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.
+   */
+  rate: number | null;
+
+  /**
+   * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
+   */
+  trackedSearchCount: number;
+
+  /**
+   * Number of add-to-cart events from this search.
+   */
+  addToCartCount: number;
+
+  /**
+   * Daily add-to-cart rates.
+   */
+  dates: DailyAddToCartRates[];
+};

package/model/getAverageClickPositionResponse.ts

@@ -1,20 +1,20 @@
 // 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 { AverageClickEvent } from './averageClickEvent';
+import type { DailyAverageClicks } from './dailyAverageClicks';
 
 export type GetAverageClickPositionResponse = {
   /**
-   * Average count of all click events.
+   * 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.
    */
-  average: number;
+  average: number | null;
 
   /**
-   * Number of click events.
+   * Number of clicks associated with this search.
    */
   clickCount: number;
 
   /**
-   * Average click positions.
+   * Daily average click positions.
    */
-  dates: AverageClickEvent[];
+  dates: DailyAverageClicks[];
 };

package/model/getClickPositionsResponse.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 { ClickPosition } from './clickPosition';
+import type { ClickPositionsInner } from './clickPositionsInner';
 
 export type GetClickPositionsResponse = {
   /**
-   * Click positions.
+   * List of positions in the search results and clicks associated with this search.
    */
-  positions: ClickPosition[];
+  positions: ClickPositionsInner[];
 };