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

package/dist/client-analytics.esm.node.js

@@ -2,7 +2,7 @@ import { createAuth, createTransporter, getAlgoliaAgent, DEFAULT_CONNECT_TIMEOUT
 import { createHttpRequester } from '@algolia/requester-node-http';
 
 // 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.
-const apiClientVersion = '5.0.0-alpha.107';
+const apiClientVersion = '5.0.0-alpha.109';
 const REGIONS = ['de', 'us'];
 function getDefaultHosts(region) {
     const url = !region
@@ -73,7 +73,7 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             if (!path) {
                 throw new Error('Parameter `path` is required when calling `customDelete`.');
             }
-            const requestPath = '/1{path}'.replace('{path}', path);
+            const requestPath = '/{path}'.replace('{path}', path);
             const headers = {};
             const queryParameters = parameters ? parameters : {};
             const request = {
@@ -96,7 +96,7 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             if (!path) {
                 throw new Error('Parameter `path` is required when calling `customGet`.');
             }
-            const requestPath = '/1{path}'.replace('{path}', path);
+            const requestPath = '/{path}'.replace('{path}', path);
             const headers = {};
             const queryParameters = parameters ? parameters : {};
             const request = {
@@ -120,7 +120,7 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             if (!path) {
                 throw new Error('Parameter `path` is required when calling `customPost`.');
             }
-            const requestPath = '/1{path}'.replace('{path}', path);
+            const requestPath = '/{path}'.replace('{path}', path);
             const headers = {};
             const queryParameters = parameters ? parameters : {};
             const request = {
@@ -145,7 +145,7 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             if (!path) {
                 throw new Error('Parameter `path` is required when calling `customPut`.');
             }
-            const requestPath = '/1{path}'.replace('{path}', path);
+            const requestPath = '/{path}'.replace('{path}', path);
             const headers = {};
             const queryParameters = parameters ? parameters : {};
             const request = {
@@ -158,7 +158,47 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             return transporter.request(request, requestOptions);
         },
         /**
-         * Return the average click position for the complete time range and for individual days. > **Note**: If all `positions` have a `clickCount` of `0` or `null`, it means Algolia didn\'t receive any click events for tracked searches. A _tracked_ search is a search request where the `clickAnalytics` parameter is `true`.
+         * Retrieves the add-to-cart rate for all of your searches with at least one add-to-cart event, including a daily breakdown.  By default, the analyzed period includes the last eight days including the current day.
+         *
+         * Required API Key ACLs:
+         * - analytics.
+         *
+         * @param getAddToCartRate - The getAddToCartRate object.
+         * @param getAddToCartRate.index - Index name.
+         * @param getAddToCartRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getAddToCartRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getAddToCartRate.tags - 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/).
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        getAddToCartRate({ index, startDate, endDate, tags }, requestOptions) {
+            if (!index) {
+                throw new Error('Parameter `index` is required when calling `getAddToCartRate`.');
+            }
+            const requestPath = '/2/conversions/addToCartRate';
+            const headers = {};
+            const queryParameters = {};
+            if (index !== undefined) {
+                queryParameters.index = index.toString();
+            }
+            if (startDate !== undefined) {
+                queryParameters.startDate = startDate.toString();
+            }
+            if (endDate !== undefined) {
+                queryParameters.endDate = endDate.toString();
+            }
+            if (tags !== undefined) {
+                queryParameters.tags = tags.toString();
+            }
+            const request = {
+                method: 'GET',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Retrieves the average click position of your search results, including a daily breakdown.  The average click position is the average of all clicked search results\' positions. For example, if users only ever click on the first result for any search, the average click position is 1. By default, the analyzed period includes the last eight days including the current day.
          *
          * Required API Key ACLs:
          * - analytics.
@@ -167,7 +207,7 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          * @param getAverageClickPosition.index - Index name.
          * @param getAverageClickPosition.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
          * @param getAverageClickPosition.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
-         * @param getAverageClickPosition.tags - 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.
+         * @param getAverageClickPosition.tags - 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/).
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
         getAverageClickPosition({ index, startDate, endDate, tags }, requestOptions) {
@@ -198,7 +238,7 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             return transporter.request(request, requestOptions);
         },
         /**
-         * Show the number of clicks events and their associated position in the search results.  > **Note**: If all `positions` have a `clickCount` of `0` or `null`, it means Algolia didn\'t receive any click events for tracked searches. A _tracked_ search is a search request where the `clickAnalytics` parameter is `true`.
+         * Retrieves the positions in the search results and their associated number of clicks.  This lets you check how many clicks the first, second, or tenth search results receive.
          *
          * Required API Key ACLs:
          * - analytics.
@@ -207,7 +247,7 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          * @param getClickPositions.index - Index name.
          * @param getClickPositions.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
          * @param getClickPositions.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
-         * @param getClickPositions.tags - 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.
+         * @param getClickPositions.tags - 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/).
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
         getClickPositions({ index, startDate, endDate, tags }, requestOptions) {
@@ -238,7 +278,7 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             return transporter.request(request, requestOptions);
         },
         /**
-         * Returns a [click-through rate (CTR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate).
+         * Retrieves the click-through rate for all of your searches with at least one click event, including a daily breakdown  By default, the analyzed period includes the last eight days including the current day.
          *
          * Required API Key ACLs:
          * - analytics.
@@ -247,7 +287,7 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          * @param getClickThroughRate.index - Index name.
          * @param getClickThroughRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
          * @param getClickThroughRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
-         * @param getClickThroughRate.tags - 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.
+         * @param getClickThroughRate.tags - 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/).
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
         getClickThroughRate({ index, startDate, endDate, tags }, requestOptions) {
@@ -278,21 +318,21 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             return transporter.request(request, requestOptions);
         },
         /**
-         * Return a [conversion rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#conversion-rate).
+         * Retrieves the conversion rate for all of your searches with at least one conversion event, including a daily breakdown.  By default, the analyzed period includes the last eight days including the current day.
          *
          * Required API Key ACLs:
          * - analytics.
          *
-         * @param getConversationRate - The getConversationRate object.
-         * @param getConversationRate.index - Index name.
-         * @param getConversationRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
-         * @param getConversationRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
-         * @param getConversationRate.tags - 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.
+         * @param getConversionRate - The getConversionRate object.
+         * @param getConversionRate.index - Index name.
+         * @param getConversionRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getConversionRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getConversionRate.tags - 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/).
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
-        getConversationRate({ index, startDate, endDate, tags }, requestOptions) {
+        getConversionRate({ index, startDate, endDate, tags }, requestOptions) {
             if (!index) {
-                throw new Error('Parameter `index` is required when calling `getConversationRate`.');
+                throw new Error('Parameter `index` is required when calling `getConversionRate`.');
             }
             const requestPath = '/2/conversions/conversionRate';
             const headers = {};
@@ -318,7 +358,7 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             return transporter.request(request, requestOptions);
         },
         /**
-         * Returns the rate at which searches don\'t lead to any clicks. The endpoint returns a value for the complete given time range, as well as a value per day. It also returns the count of searches and searches without clicks.
+         * Retrieves the fraction of searches that didn\'t lead to any click within a time range, including a daily breakdown.  By default, the analyzed period includes the last eight days including the current day.
          *
          * Required API Key ACLs:
          * - analytics.
@@ -327,7 +367,7 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          * @param getNoClickRate.index - Index name.
          * @param getNoClickRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
          * @param getNoClickRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
-         * @param getNoClickRate.tags - 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.
+         * @param getNoClickRate.tags - 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/).
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
         getNoClickRate({ index, startDate, endDate, tags }, requestOptions) {
@@ -358,7 +398,7 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             return transporter.request(request, requestOptions);
         },
         /**
-         * Returns the rate at which searches didn\'t return any results.
+         * Retrieves the fraction of searches that didn\'t return any results within a time range, including a daily breakdown.  By default, the analyzed period includes the last eight days including the current day.
          *
          * Required API Key ACLs:
          * - analytics.
@@ -367,7 +407,7 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          * @param getNoResultsRate.index - Index name.
          * @param getNoResultsRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
          * @param getNoResultsRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
-         * @param getNoResultsRate.tags - 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.
+         * @param getNoResultsRate.tags - 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/).
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
         getNoResultsRate({ index, startDate, endDate, tags }, requestOptions) {
@@ -398,7 +438,87 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             return transporter.request(request, requestOptions);
         },
         /**
-         * Returns the number of searches within a time range.
+         * Retrieves the purchase rate for all of your searches with at least one purchase event, including a daily breakdown.  By default, the analyzed period includes the last eight days including the current day.
+         *
+         * Required API Key ACLs:
+         * - analytics.
+         *
+         * @param getPurchaseRate - The getPurchaseRate object.
+         * @param getPurchaseRate.index - Index name.
+         * @param getPurchaseRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getPurchaseRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getPurchaseRate.tags - 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/).
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        getPurchaseRate({ index, startDate, endDate, tags }, requestOptions) {
+            if (!index) {
+                throw new Error('Parameter `index` is required when calling `getPurchaseRate`.');
+            }
+            const requestPath = '/2/conversions/purchaseRate';
+            const headers = {};
+            const queryParameters = {};
+            if (index !== undefined) {
+                queryParameters.index = index.toString();
+            }
+            if (startDate !== undefined) {
+                queryParameters.startDate = startDate.toString();
+            }
+            if (endDate !== undefined) {
+                queryParameters.endDate = endDate.toString();
+            }
+            if (tags !== undefined) {
+                queryParameters.tags = tags.toString();
+            }
+            const request = {
+                method: 'GET',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Retrieves revenue-related metrics, such as the total revenue or the average order value.  To retrieve revenue-related metrics, sent purchase events. By default, the analyzed period includes the last eight days including the current day.
+         *
+         * Required API Key ACLs:
+         * - analytics.
+         *
+         * @param getRevenue - The getRevenue object.
+         * @param getRevenue.index - Index name.
+         * @param getRevenue.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getRevenue.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getRevenue.tags - 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/).
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        getRevenue({ index, startDate, endDate, tags }, requestOptions) {
+            if (!index) {
+                throw new Error('Parameter `index` is required when calling `getRevenue`.');
+            }
+            const requestPath = '/2/conversions/revenue';
+            const headers = {};
+            const queryParameters = {};
+            if (index !== undefined) {
+                queryParameters.index = index.toString();
+            }
+            if (startDate !== undefined) {
+                queryParameters.startDate = startDate.toString();
+            }
+            if (endDate !== undefined) {
+                queryParameters.endDate = endDate.toString();
+            }
+            if (tags !== undefined) {
+                queryParameters.tags = tags.toString();
+            }
+            const request = {
+                method: 'GET',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Retrieves the number of searches within a time range, including a daily breakdown.  By default, the analyzed period includes the last eight days including the current day.
          *
          * Required API Key ACLs:
          * - analytics.
@@ -407,7 +527,7 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          * @param getSearchesCount.index - Index name.
          * @param getSearchesCount.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
          * @param getSearchesCount.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
-         * @param getSearchesCount.tags - 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.
+         * @param getSearchesCount.tags - 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/).
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
         getSearchesCount({ index, startDate, endDate, tags }, requestOptions) {
@@ -438,7 +558,7 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             return transporter.request(request, requestOptions);
         },
         /**
-         * Return the most popular of the last 1,000 searches that didn\'t lead to any clicks.
+         * Retrieves the most popular searches that didn\'t lead to any clicks, from the 1,000 most frequent searches.
          *
          * Required API Key ACLs:
          * - analytics.
@@ -449,7 +569,7 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          * @param getSearchesNoClicks.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
          * @param getSearchesNoClicks.limit - Number of items to return.
          * @param getSearchesNoClicks.offset - Position of the first item to return.
-         * @param getSearchesNoClicks.tags - 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.
+         * @param getSearchesNoClicks.tags - 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/).
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
         getSearchesNoClicks({ index, startDate, endDate, limit, offset, tags, }, requestOptions) {
@@ -486,7 +606,7 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             return transporter.request(request, requestOptions);
         },
         /**
-         * Returns the most popular of the latest 1,000 searches that didn\'t return any results.
+         * Retrieves the most popular searches that didn\'t return any results.
          *
          * Required API Key ACLs:
          * - analytics.
@@ -497,7 +617,7 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          * @param getSearchesNoResults.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
          * @param getSearchesNoResults.limit - Number of items to return.
          * @param getSearchesNoResults.offset - Position of the first item to return.
-         * @param getSearchesNoResults.tags - 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.
+         * @param getSearchesNoResults.tags - 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/).
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
         getSearchesNoResults({ index, startDate, endDate, limit, offset, tags, }, requestOptions) {
@@ -534,7 +654,7 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             return transporter.request(request, requestOptions);
         },
         /**
-         * Return the latest update time of the Analytics API for an index. If the index has been recently created or no search has been performed yet, `updatedAt` will be `null`. > **Note**: The Analytics API is updated every 5 minutes.
+         * Retrieves the time when the Analytics data for the specified index was last updated.  The Analytics data is updated every 5 minutes.
          *
          * Required API Key ACLs:
          * - analytics.
@@ -562,7 +682,7 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             return transporter.request(request, requestOptions);
         },
         /**
-         * Returns top countries. Limited to the 1,000 most frequent ones.
+         * Retrieves the countries with the most searches to your index.
          *
          * Required API Key ACLs:
          * - analytics.
@@ -573,7 +693,7 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          * @param getTopCountries.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
          * @param getTopCountries.limit - Number of items to return.
          * @param getTopCountries.offset - Position of the first item to return.
-         * @param getTopCountries.tags - 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.
+         * @param getTopCountries.tags - 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/).
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
         getTopCountries({ index, startDate, endDate, limit, offset, tags }, requestOptions) {
@@ -610,19 +730,19 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             return transporter.request(request, requestOptions);
         },
         /**
-         * Return the most popular [filterable attributes](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/) in the 1,000 most recently used filters.
+         * Retrieves the most frequently used filter attributes.  These are attributes of your records that you included in the `attributesForFaceting` setting.
          *
          * Required API Key ACLs:
          * - analytics.
          *
          * @param getTopFilterAttributes - The getTopFilterAttributes object.
          * @param getTopFilterAttributes.index - Index name.
-         * @param getTopFilterAttributes.search - User query.
+         * @param getTopFilterAttributes.search - Search query.
          * @param getTopFilterAttributes.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
          * @param getTopFilterAttributes.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
          * @param getTopFilterAttributes.limit - Number of items to return.
          * @param getTopFilterAttributes.offset - Position of the first item to return.
-         * @param getTopFilterAttributes.tags - 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.
+         * @param getTopFilterAttributes.tags - 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/).
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
         getTopFilterAttributes({ index, search, startDate, endDate, limit, offset, tags, }, requestOptions) {
@@ -662,7 +782,7 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             return transporter.request(request, requestOptions);
         },
         /**
-         * Returns the most popular filter values for an attribute in the 1,000 most recently used filters.
+         * Retrieves the most frequent filter (facet) values for a filter attribute.  These are attributes of your records that you included in the `attributesForFaceting` setting.
          *
          * Required API Key ACLs:
          * - analytics.
@@ -670,12 +790,12 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          * @param getTopFilterForAttribute - The getTopFilterForAttribute object.
          * @param getTopFilterForAttribute.attribute - Attribute name.
          * @param getTopFilterForAttribute.index - Index name.
-         * @param getTopFilterForAttribute.search - User query.
+         * @param getTopFilterForAttribute.search - Search query.
          * @param getTopFilterForAttribute.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
          * @param getTopFilterForAttribute.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
          * @param getTopFilterForAttribute.limit - Number of items to return.
          * @param getTopFilterForAttribute.offset - Position of the first item to return.
-         * @param getTopFilterForAttribute.tags - 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.
+         * @param getTopFilterForAttribute.tags - 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/).
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
         getTopFilterForAttribute({ attribute, index, search, startDate, endDate, limit, offset, tags, }, requestOptions) {
@@ -718,19 +838,19 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             return transporter.request(request, requestOptions);
         },
         /**
-         * Returns top filters for filter-enabled searches that don\'t return results. Limited to the 1,000 most recently used filters.
+         * Retrieves the most frequently used filters for a search that didn\'t return any results.  To get the most frequent searches without results, use the [Retrieve searches without results](#tag/search/operation/getSearchesNoResults) operation.
          *
          * Required API Key ACLs:
          * - analytics.
          *
          * @param getTopFiltersNoResults - The getTopFiltersNoResults object.
          * @param getTopFiltersNoResults.index - Index name.
-         * @param getTopFiltersNoResults.search - User query.
+         * @param getTopFiltersNoResults.search - Search query.
          * @param getTopFiltersNoResults.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
          * @param getTopFiltersNoResults.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
          * @param getTopFiltersNoResults.limit - Number of items to return.
          * @param getTopFiltersNoResults.offset - Position of the first item to return.
-         * @param getTopFiltersNoResults.tags - 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.
+         * @param getTopFiltersNoResults.tags - 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/).
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
         getTopFiltersNoResults({ index, search, startDate, endDate, limit, offset, tags, }, requestOptions) {
@@ -770,23 +890,24 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             return transporter.request(request, requestOptions);
         },
         /**
-         * Return the most popular clicked results in the last 1,000 searches.
+         * Retrieves the object IDs of the most frequent search results.
          *
          * Required API Key ACLs:
          * - analytics.
          *
          * @param getTopHits - The getTopHits object.
          * @param getTopHits.index - Index name.
-         * @param getTopHits.search - User query.
-         * @param getTopHits.clickAnalytics - Whether to include [click and conversion](https://www.algolia.com/doc/guides/sending-events/getting-started/) rates for a search.
+         * @param getTopHits.search - Search query.
+         * @param getTopHits.clickAnalytics - Whether to include metrics related to click and conversion events in the response.
+         * @param getTopHits.revenueAnalytics - Whether to include revenue-related metrics in the response.  If true, metrics related to click and conversion events are also included in the response.
          * @param getTopHits.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
          * @param getTopHits.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
          * @param getTopHits.limit - Number of items to return.
          * @param getTopHits.offset - Position of the first item to return.
-         * @param getTopHits.tags - 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.
+         * @param getTopHits.tags - 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/).
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
-        getTopHits({ index, search, clickAnalytics, startDate, endDate, limit, offset, tags, }, requestOptions) {
+        getTopHits({ index, search, clickAnalytics, revenueAnalytics, startDate, endDate, limit, offset, tags, }, requestOptions) {
             if (!index) {
                 throw new Error('Parameter `index` is required when calling `getTopHits`.');
             }
@@ -802,6 +923,9 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             if (clickAnalytics !== undefined) {
                 queryParameters.clickAnalytics = clickAnalytics.toString();
             }
+            if (revenueAnalytics !== undefined) {
+                queryParameters.revenueAnalytics = revenueAnalytics.toString();
+            }
             if (startDate !== undefined) {
                 queryParameters.startDate = startDate.toString();
             }
@@ -826,24 +950,25 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             return transporter.request(request, requestOptions);
         },
         /**
-         * Returns the most popular of the latest 1,000 searches. For each search, also returns the number of hits.
+         * Returns the most popular search terms.
          *
          * Required API Key ACLs:
          * - analytics.
          *
          * @param getTopSearches - The getTopSearches object.
          * @param getTopSearches.index - Index name.
-         * @param getTopSearches.clickAnalytics - Whether to include [click and conversion](https://www.algolia.com/doc/guides/sending-events/getting-started/) rates for a search.
+         * @param getTopSearches.clickAnalytics - Whether to include metrics related to click and conversion events in the response.
+         * @param getTopSearches.revenueAnalytics - Whether to include revenue-related metrics in the response.  If true, metrics related to click and conversion events are also included in the response.
          * @param getTopSearches.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
          * @param getTopSearches.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
-         * @param getTopSearches.orderBy - Reorder the results.
+         * @param getTopSearches.orderBy - Attribute by which to order the response items.  If the `clickAnalytics` parameter is false, only `searchCount` is available.
          * @param getTopSearches.direction - Sorting direction of the results: ascending or descending.
          * @param getTopSearches.limit - Number of items to return.
          * @param getTopSearches.offset - Position of the first item to return.
-         * @param getTopSearches.tags - 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.
+         * @param getTopSearches.tags - 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/).
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
-        getTopSearches({ index, clickAnalytics, startDate, endDate, orderBy, direction, limit, offset, tags, }, requestOptions) {
+        getTopSearches({ index, clickAnalytics, revenueAnalytics, startDate, endDate, orderBy, direction, limit, offset, tags, }, requestOptions) {
             if (!index) {
                 throw new Error('Parameter `index` is required when calling `getTopSearches`.');
             }
@@ -856,6 +981,9 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             if (clickAnalytics !== undefined) {
                 queryParameters.clickAnalytics = clickAnalytics.toString();
             }
+            if (revenueAnalytics !== undefined) {
+                queryParameters.revenueAnalytics = revenueAnalytics.toString();
+            }
             if (startDate !== undefined) {
                 queryParameters.startDate = startDate.toString();
             }
@@ -886,7 +1014,7 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             return transporter.request(request, requestOptions);
         },
         /**
-         * Return the count of unique users.
+         * Retrieves the number of unique users within a time range, including a daily breakdown.  Since this endpoint returns the number of unique users, the sum of the daily values might be different from the total number.  By default, Algolia distinguishes search users by their IP address, _unless_ you include a pseudonymous user identifier in your search requests with the `userToken` API parameter or `x-algolia-usertoken` request header. By default, the analyzed period includes the last eight days including the current day.
          *
          * Required API Key ACLs:
          * - analytics.
@@ -895,7 +1023,7 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          * @param getUsersCount.index - Index name.
          * @param getUsersCount.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
          * @param getUsersCount.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
-         * @param getUsersCount.tags - 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.
+         * @param getUsersCount.tags - 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/).
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
         getUsersCount({ index, startDate, endDate, tags }, requestOptions) {