@algolia/client-analytics 5.18.0 → 5.20.0

package/dist/fetch.d.ts

@@ -3,7 +3,7 @@ import { CreateClientOptions, RequestOptions, ClientOptions } from '@algolia/cli
 
 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.
+     * Add-to-cart rate: calculated as the 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;
     /**
@@ -22,7 +22,7 @@ type DailyAddToCartRates = {
 
 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.
+     * Add-to-cart rate: calculated as the 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;
     /**
@@ -92,7 +92,7 @@ type GetClickPositionsResponse = {
 
 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.
+     * Click-through rate: calculated as the 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;
     /**
@@ -111,7 +111,7 @@ type DailyClickThroughRates = {
 
 type GetClickThroughRateResponse = {
     /**
-     * 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.
+     * Click-through rate: calculated as the 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;
     /**
@@ -130,7 +130,7 @@ type GetClickThroughRateResponse = {
 
 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.
+     * Conversion rate: calculated as the 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;
     /**
@@ -149,7 +149,7 @@ type DailyConversionRates = {
 
 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.
+     * Conversion rate: calculated as the 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;
     /**
@@ -168,7 +168,7 @@ type GetConversionRateResponse = {
 
 type DailyNoClickRates = {
     /**
-     * No click rate, calculated as number of tracked searches without any click divided by the number of tracked searches.
+     * No click rate: calculated as the number of tracked searches without clicks divided by the number of tracked searches.
      */
     rate: number;
     /**
@@ -187,7 +187,7 @@ type DailyNoClickRates = {
 
 type GetNoClickRateResponse = {
     /**
-     * No click rate, calculated as number of tracked searches without any click divided by the number of tracked searches.
+     * No click rate: calculated as the number of tracked searches without clicks divided by the number of tracked searches.
      */
     rate: number;
     /**
@@ -218,14 +218,14 @@ type DailyNoResultsRates = {
      */
     count: number;
     /**
-     * No results rate, calculated as number of searches with zero results divided by the total number of searches.
+     * No results rate: calculated as the number of searches with zero results divided by the total number of searches.
      */
     rate: number;
 };
 
 type GetNoResultsRateResponse = {
     /**
-     * No results rate, calculated as number of searches with zero results divided by the total number of searches.
+     * No results rate: calculated as the number of searches with zero results divided by the total number of searches.
      */
     rate: number;
     /**
@@ -244,7 +244,7 @@ type GetNoResultsRateResponse = {
 
 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.
+     * Purchase rate: calculated as the 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;
     /**
@@ -263,7 +263,7 @@ type DailyPurchaseRates = {
 
 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.
+     * Purchase rate: calculated as the 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;
     /**
@@ -296,7 +296,7 @@ type CurrencyCode = {
 
 type DailyRevenue = {
     /**
-     * Revenue associated with this search, broken-down by currencies.
+     * Revenue associated with this search: broken down by currency.
      */
     currencies: {
         [key: string]: CurrencyCode;
@@ -309,7 +309,7 @@ type DailyRevenue = {
 
 type GetRevenue = {
     /**
-     * Revenue associated with this search, broken-down by currencies.
+     * Revenue associated with this search: broken down by currency.
      */
     currencies: {
         [key: string]: CurrencyCode;
@@ -482,14 +482,14 @@ type GetTopFiltersNoResultsValues = {
 
 type GetTopFiltersNoResultsResponse = {
     /**
-     * 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.
+     * Filters for searches without any results. If null, the search term specified with the `search` parameter isn\'t a search without results, or the `search` parameter is absent from the request.
      */
     values: Array<GetTopFiltersNoResultsValues> | null;
 };
 
 type TopHit = {
     /**
-     * Object ID of a record that\'s returned as a search result.
+     * Object ID of a record returned as a search result.
      */
     hit: string;
     /**
@@ -507,7 +507,7 @@ type TopHitsResponse = {
 
 type TopHitWithAnalytics = {
     /**
-     * Object ID of a record that\'s returned as a search result.
+     * Object ID of a record returned as a search result.
      */
     hit: string;
     /**
@@ -515,11 +515,11 @@ type TopHitWithAnalytics = {
      */
     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.
+     * Click-through rate: calculated as the 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.
+     * Conversion rate: calculated as the 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;
     /**
@@ -545,7 +545,7 @@ type TopHitsResponseWithAnalytics = {
 
 type TopHitWithRevenueAnalytics = {
     /**
-     * Object ID of a record that\'s returned as a search result.
+     * Object ID of a record returned as a search result.
      */
     hit: string;
     /**
@@ -553,11 +553,11 @@ type TopHitWithRevenueAnalytics = {
      */
     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.
+     * Click-through rate: calculated as the 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.
+     * Conversion rate: calculated as the 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;
     /**
@@ -573,7 +573,7 @@ type TopHitWithRevenueAnalytics = {
      */
     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.
+     * Add-to-cart rate: calculated as the 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;
     /**
@@ -581,7 +581,7 @@ type TopHitWithRevenueAnalytics = {
      */
     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.
+     * Purchase rate: calculated as the 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;
     /**
@@ -589,7 +589,7 @@ type TopHitWithRevenueAnalytics = {
      */
     purchaseCount: number;
     /**
-     * Revenue associated with this search, broken-down by currencies.
+     * Revenue associated with this search: broken down by currency.
      */
     currencies: {
         [key: string]: CurrencyCode;
@@ -637,7 +637,7 @@ type TopSearchWithAnalytics = {
      */
     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.
+     * Click-through rate: calculated as the 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;
     /**
@@ -649,7 +649,7 @@ type TopSearchWithAnalytics = {
      */
     clickPositions: Array<ClickPosition>;
     /**
-     * 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.
+     * Conversion rate: calculated as the 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;
     /**
@@ -687,7 +687,7 @@ type TopSearchWithRevenueAnalytics = {
      */
     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.
+     * Click-through rate: calculated as the 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;
     /**
@@ -699,7 +699,7 @@ type TopSearchWithRevenueAnalytics = {
      */
     clickPositions: Array<ClickPosition>;
     /**
-     * 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.
+     * Conversion rate: calculated as the 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;
     /**
@@ -719,13 +719,13 @@ type TopSearchWithRevenueAnalytics = {
      */
     nbHits: number;
     /**
-     * Revenue associated with this search, broken-down by currencies.
+     * Revenue associated with this search: broken down by currency.
      */
     currencies: {
         [key: string]: CurrencyCode;
     };
     /**
-     * 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.
+     * Add-to-cart rate: calculated as the 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;
     /**
@@ -733,7 +733,7 @@ type TopSearchWithRevenueAnalytics = {
      */
     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.
+     * Purchase rate: calculated as the 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;
     /**
@@ -1274,7 +1274,7 @@ type GetTopHitsProps = {
      */
     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.
+     * Whether to include metrics related to revenue events in the response.
      */
     revenueAnalytics?: boolean;
     /**
@@ -1311,7 +1311,7 @@ type GetTopSearchesProps = {
      */
     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.
+     * Whether to include metrics related to revenue events in the response.
      */
     revenueAnalytics?: boolean;
     /**
@@ -1365,7 +1365,7 @@ type GetUsersCountProps = {
     tags?: string;
 };
 
-declare const apiClientVersion = "5.18.0";
+declare const apiClientVersion = "5.20.0";
 declare const REGIONS: readonly ["de", "us"];
 type Region = (typeof REGIONS)[number];
 type RegionOptions = {
@@ -1377,6 +1377,10 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
      * The `appId` currently in use.
      */
     appId: string;
+    /**
+     * The `apiKey` currently in use.
+     */
+    apiKey: string;
     /**
      * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
      */
@@ -1436,7 +1440,7 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
      */
     customPut({ path, parameters, body }: CustomPutProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
     /**
-     * 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.
+     * Retrieves the add-to-cart rate for all 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.  The rate is the number of add-to-cart conversion events divided by the number of tracked searches. A search is tracked if it returns a queryID (`clickAnalytics` is `true`). This differs from the response\'s `count`, which shows the overall number of searches, including those where `clickAnalytics` is `false`.  **There\'s a difference between a 0 and null add-to-cart rate when `clickAnalytics` is enabled:**  - **Null** means there were no queries: since Algolia didn\'t receive any events, the add-to-cart rate is null. - **0** mean there _were_ queries but no [add-to-cart events](https://www.algolia.com/doc/guides/sending-events/getting-started/) were received.
      *
      * Required API Key ACLs:
      *  - analytics
@@ -1449,7 +1453,7 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
      */
     getAddToCartRate({ index, startDate, endDate, tags }: GetAddToCartRateProps, requestOptions?: RequestOptions): Promise<GetAddToCartRateResponse>;
     /**
-     * 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.
+     * Retrieves the average click position of your search results, including a daily breakdown.  The average click position is the average of all clicked search result 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.  An average of `null` when `clickAnalytics` is enabled means Algolia didn\'t receive any [click events](https://www.algolia.com/doc/guides/sending-events/getting-started/) for the queries. The average is `null` until Algolia receives at least one click event.
      *
      * Required API Key ACLs:
      *  - analytics
@@ -1462,7 +1466,7 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
      */
     getAverageClickPosition({ index, startDate, endDate, tags }: GetAverageClickPositionProps, requestOptions?: RequestOptions): Promise<GetAverageClickPositionResponse>;
     /**
-     * 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.
+     * 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.  An average of `0` when `clickAnalytics` is enabled means Algolia didn\'t receive any [click events](https://www.algolia.com/doc/guides/sending-events/getting-started/) for the queries.
      *
      * Required API Key ACLs:
      *  - analytics
@@ -1475,7 +1479,7 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
      */
     getClickPositions({ index, startDate, endDate, tags }: GetClickPositionsProps, requestOptions?: RequestOptions): Promise<GetClickPositionsResponse>;
     /**
-     * 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.
+     * Retrieves the click-through rate (CTR) for all 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.  **There\'s a difference between a 0 and null CTR when `clickAnalytics` is enabled:**  - **Null** means there were no queries: since Algolia didn\'t receive any events, CTR is null. - **0** mean there _were_ queries but no [click events](https://www.algolia.com/doc/guides/sending-events/getting-started/) were received.
      *
      * Required API Key ACLs:
      *  - analytics
@@ -1488,7 +1492,7 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
      */
     getClickThroughRate({ index, startDate, endDate, tags }: GetClickThroughRateProps, requestOptions?: RequestOptions): Promise<GetClickThroughRateResponse>;
     /**
-     * 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.
+     * Retrieves the conversion rate (CR) for all 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.  **There\'s a difference between a 0 and null CR when `clickAnalytics` is enabled:**  - **Null** means there were no queries: since Algolia didn\'t receive any events, CR is null. - **0** mean there _were_ queries but no [conversion events](https://www.algolia.com/doc/guides/sending-events/getting-started/) were received.
      *
      * Required API Key ACLs:
      *  - analytics
@@ -1501,7 +1505,7 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
      */
     getConversionRate({ index, startDate, endDate, tags }: GetConversionRateProps, requestOptions?: RequestOptions): Promise<GetConversionRateResponse>;
     /**
-     * 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.
+     * Retrieves the fraction of searches that didn\'t lead to any click within a time range, including a daily breakdown. It also returns the number of tracked searches and tracked searches without clicks.  By default, the analyzed period includes the last eight days including the current day.
      *
      * Required API Key ACLs:
      *  - analytics
@@ -1514,7 +1518,7 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
      */
     getNoClickRate({ index, startDate, endDate, tags }: GetNoClickRateProps, requestOptions?: RequestOptions): Promise<GetNoClickRateResponse>;
     /**
-     * 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.
+     * Retrieves the fraction of searches that didn\'t return any results within a time range, including a daily breakdown. It also returns the count of searches and searches without results used to compute the rates.  By default, the analyzed period includes the last eight days including the current day.
      *
      * Required API Key ACLs:
      *  - analytics
@@ -1527,7 +1531,7 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
      */
     getNoResultsRate({ index, startDate, endDate, tags }: GetNoResultsRateProps, requestOptions?: RequestOptions): Promise<GetNoResultsRateResponse>;
     /**
-     * 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.
+     * Retrieves the purchase rate for all 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.  The rate is the number of purchase conversion events divided by the number of tracked searches. A search is tracked if it returns a query ID (`clickAnalytics` is `true`). This differs from the response\'s `count`, which shows the overall number of searches, including those where `clickAnalytics` is `false`.  **There\'s a difference between a 0 and null purchase rate when `clickAnalytics` is enabled:**  - **Null** means there were no queries: since Algolia didn\'t receive any events, the purchase rate is null. - **0** mean there _were_ queries but no [purchase conversion events](https://www.algolia.com/doc/guides/sending-events/getting-started/) were received.
      *
      * Required API Key ACLs:
      *  - analytics
@@ -1540,7 +1544,7 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
      */
     getPurchaseRate({ index, startDate, endDate, tags }: GetPurchaseRateProps, requestOptions?: RequestOptions): Promise<GetPurchaseRateResponse>;
     /**
-     * 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.
+     * Retrieves revenue-related metrics, such as the total revenue or the average order value.  To retrieve revenue-related metrics, send purchase events. By default, the analyzed period includes the last eight days including the current day.  Revenue is based on purchase conversion events (a conversion event with an `eventSubtype` attribute of `purchase`). The revenue is the `price` attribute multiplied by the `quantity` attribute for each object in the event\'s `objectData` array.
      *
      * Required API Key ACLs:
      *  - analytics
@@ -1566,7 +1570,7 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
      */
     getSearchesCount({ index, startDate, endDate, tags }: GetSearchesCountProps, requestOptions?: RequestOptions): Promise<GetSearchesCountResponse>;
     /**
-     * Retrieves the most popular searches that didn\'t lead to any clicks, from the 1,000 most frequent searches.
+     * Retrieves the most popular searches that didn\'t lead to any clicks, from the 1,000 most frequent searches.  For each search, it also returns the number of displayed search results that remained unclicked.
      *
      * Required API Key ACLs:
      *  - analytics
@@ -1581,7 +1585,7 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
      */
     getSearchesNoClicks({ index, startDate, endDate, limit, offset, tags }: GetSearchesNoClicksProps, requestOptions?: RequestOptions): Promise<GetSearchesNoClicksResponse>;
     /**
-     * Retrieves the most popular searches that didn\'t return any results.
+     * Retrieves the 1,000 most frequent searches that produced zero results.
      *
      * Required API Key ACLs:
      *  - analytics
@@ -1596,7 +1600,7 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
      */
     getSearchesNoResults({ index, startDate, endDate, limit, offset, tags }: GetSearchesNoResultsProps, requestOptions?: RequestOptions): Promise<GetSearchesNoResultsResponse>;
     /**
-     * Retrieves the time when the Analytics data for the specified index was last updated.  The Analytics data is updated every 5 minutes.
+     * Retrieves the time when the Analytics data for the specified index was last updated.  If the index has been recently created or no search has been performed yet the updated time is `null`.  The Analytics data is updated every 5&nbsp;minutes.
      *
      * Required API Key ACLs:
      *  - analytics
@@ -1606,7 +1610,7 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
      */
     getStatus({ index }: GetStatusProps, requestOptions?: RequestOptions): Promise<GetStatusResponse>;
     /**
-     * Retrieves the countries with the most searches to your index.
+     * Retrieves the countries with the most searches in your index.
      *
      * Required API Key ACLs:
      *  - analytics
@@ -1621,7 +1625,7 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
      */
     getTopCountries({ index, startDate, endDate, limit, offset, tags }: GetTopCountriesProps, requestOptions?: RequestOptions): Promise<GetTopCountriesResponse>;
     /**
-     * Retrieves the most frequently used filter attributes.  These are attributes of your records that you included in the `attributesForFaceting` setting.
+     * Retrieves the 1,000 most frequently used filter attributes.  These are attributes of your records that you included in the `attributesForFaceting` setting.
      *
      * Required API Key ACLs:
      *  - analytics
@@ -1637,7 +1641,7 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
      */
     getTopFilterAttributes({ index, search, startDate, endDate, limit, offset, tags }: GetTopFilterAttributesProps, requestOptions?: RequestOptions): Promise<GetTopFilterAttributesResponse>;
     /**
-     * Retrieves the most frequent filter (facet) values for a filter attribute.  These are attributes of your records that you included in the `attributesForFaceting` setting.
+     * Retrieves the 1,000 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
@@ -1654,7 +1658,7 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
      */
     getTopFilterForAttribute({ attribute, index, search, startDate, endDate, limit, offset, tags }: GetTopFilterForAttributeProps, requestOptions?: RequestOptions): Promise<GetTopFilterForAttributeResponse>;
     /**
-     * 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.
+     * Retrieves the 1,000 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
@@ -1670,7 +1674,7 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
      */
     getTopFiltersNoResults({ index, search, startDate, endDate, limit, offset, tags }: GetTopFiltersNoResultsProps, requestOptions?: RequestOptions): Promise<GetTopFiltersNoResultsResponse>;
     /**
-     * Retrieves the object IDs of the most frequent search results.
+     * Retrieves the object IDs of the 1,000 most frequent search results.  If you set the `clickAnalytics` query parameter to true, the response also includes:  - Tracked searches count. Tracked searches are Search API requests with the `clickAnalytics` parameter set to `true`. This differs from the response\'s `count`, which shows the overall number of searches, including those where `clickAnalytics` is `false`. - Click count - Click-through rate (CTR) - Conversion count - Conversion rate (CR) - Average click position  If you set the `revenueAnalytics` parameter to `true`, the response also includes:  - Add-to-cart count - Add-to-cart rate (ATCR) - Purchase count - Purchase rate - Revenue details for each currency  **There\'s a difference between 0% rates and null rates:**  - **Null** means there were no queries: since Algolia didn\'t receive any events, the rates (CTR, CR, ATCR, purchase rate) are null. - **0% rates** mean there _were_ queries but no [click or conversion events](https://www.algolia.com/doc/guides/sending-events/getting-started/) were received.
      *
      * Required API Key ACLs:
      *  - analytics
@@ -1678,7 +1682,7 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
      * @param getTopHits.index - Index name.
      * @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.revenueAnalytics - Whether to include metrics related to revenue events in the response.
      * @param getTopHits.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
      * @param getTopHits.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
      * @param getTopHits.limit - Number of items to return.
@@ -1688,14 +1692,14 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
      */
     getTopHits({ index, search, clickAnalytics, revenueAnalytics, startDate, endDate, limit, offset, tags }: GetTopHitsProps, requestOptions?: RequestOptions): Promise<GetTopHitsResponse>;
     /**
-     * Returns the most popular search terms.
+     * Returns the most popular searches. For each search, it also includes the average number of hits.  If you set the `clickAnalytics` query parameter to `true`, the response also includes  - Tracked searches count. Tracked searches are Search API requests with the `clickAnalytics` parameter set to `true`. This differs from the response\'s `count`, which shows the overall number of searches, including those where `clickAnalytics` is `false`. - Click count - Click-through rate (CTR) - Conversion count - Conversion rate (CR) - Average click position  If you set the `revenueAnalytics` query parameter to `true`, the response also includes:  - Add-to-cart count - Add-to-cart rate (ATCR) - Purchase count - Purchase rate - Revenue details for each currency  **There\'s a difference between 0% rates and null rates:**  - **Null** means there were no queries: since Algolia didn\'t receive any events, the rates (CTR, CR, ATCR, purchase rate) are null. - **0% rates** mean there _were_ queries but no [click or conversion events](https://www.algolia.com/doc/guides/sending-events/getting-started/) were received.
      *
      * Required API Key ACLs:
      *  - analytics
      * @param getTopSearches - The getTopSearches object.
      * @param getTopSearches.index - Index name.
      * @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.revenueAnalytics - Whether to include metrics related to revenue events in the response.
      * @param getTopSearches.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
      * @param getTopSearches.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
      * @param getTopSearches.orderBy - Attribute by which to order the response items.  If the `clickAnalytics` parameter is false, only `searchCount` is available.
@@ -1707,7 +1711,7 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
      */
     getTopSearches({ index, clickAnalytics, revenueAnalytics, startDate, endDate, orderBy, direction, limit, offset, tags, }: GetTopSearchesProps, requestOptions?: RequestOptions): Promise<GetTopSearchesResponse>;
     /**
-     * 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.
+     * Retrieves the number of unique users within a time range, including a daily breakdown.  Since it 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. - The analyzed period includes the last eight days including the current day.
      *
      * Required API Key ACLs:
      *  - analytics