@algolia/client-analytics 5.7.0 → 5.8.0

package/dist/node.d.cts

@@ -1,1355 +1,1371 @@
 import * as _algolia_client_common from '@algolia/client-common';
 import { CreateClientOptions, RequestOptions, ClientOptions } from '@algolia/client-common';
 
-type Direction = 'asc' | 'desc';
-
-/**
- * Attribute by which to order the response items.  If the `clickAnalytics` parameter is false, only `searchCount` is available.
- */
-type OrderBy = 'averageClickPosition' | 'clickThroughRate' | 'conversionRate' | 'searchCount';
-
-/**
- * Properties for the `customDelete` method.
- */
-type CustomDeleteProps = {
+type DailyAddToCartRates = {
     /**
-     * Path of the endpoint, anything after \"/1\" must be specified.
+     * 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.
      */
-    path: string;
+    rate: number | null;
     /**
-     * Query parameters to apply to the current query.
+     * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
      */
-    parameters?: Record<string, any>;
-};
-/**
- * Properties for the `customGet` method.
- */
-type CustomGetProps = {
+    trackedSearchCount: number;
     /**
-     * Path of the endpoint, anything after \"/1\" must be specified.
+     * Number of add-to-cart events from this search.
      */
-    path: string;
+    addToCartCount: number;
     /**
-     * Query parameters to apply to the current query.
+     * Date in the format YYYY-MM-DD.
      */
-    parameters?: Record<string, any>;
+    date: string;
 };
-/**
- * Properties for the `customPost` method.
- */
-type CustomPostProps = {
+
+type GetAddToCartRateResponse = {
     /**
-     * Path of the endpoint, anything after \"/1\" must be specified.
+     * 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.
      */
-    path: string;
+    rate: number | null;
     /**
-     * Query parameters to apply to the current query.
+     * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
      */
-    parameters?: Record<string, any>;
+    trackedSearchCount: number;
     /**
-     * Parameters to send with the custom request.
+     * Number of add-to-cart events from this search.
      */
-    body?: Record<string, unknown>;
-};
-/**
- * Properties for the `customPut` method.
- */
-type CustomPutProps = {
+    addToCartCount: number;
     /**
-     * Path of the endpoint, anything after \"/1\" must be specified.
+     * Daily add-to-cart rates.
      */
-    path: string;
+    dates: Array<DailyAddToCartRates>;
+};
+
+type DailyAverageClicks = {
     /**
-     * Query parameters to apply to the current query.
+     * 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.
      */
-    parameters?: Record<string, any>;
+    average: number | null;
     /**
-     * Parameters to send with the custom request.
+     * Number of clicks associated with this search.
      */
-    body?: Record<string, unknown>;
-};
-/**
- * Properties for the `getAddToCartRate` method.
- */
-type GetAddToCartRateProps = {
+    clickCount: number;
     /**
-     * Index name.
+     * Date in the format YYYY-MM-DD.
      */
-    index: string;
+    date: string;
+};
+
+type GetAverageClickPositionResponse = {
     /**
-     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     * 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.
      */
-    startDate?: string;
+    average: number | null;
     /**
-     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     * Number of clicks associated with this search.
      */
-    endDate?: string;
+    clickCount: number;
     /**
-     * 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/).
+     * Daily average click positions.
      */
-    tags?: string;
+    dates: Array<DailyAverageClicks>;
 };
+
 /**
- * Properties for the `getAverageClickPosition` method.
+ * Click position.
  */
-type GetAverageClickPositionProps = {
-    /**
-     * Index name.
-     */
-    index: string;
+type ClickPosition = {
     /**
-     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     * Range of positions in the search results, using the pattern `[start,end]`.  For positions 11 and up, click events are summed over the specified range. `-1` indicates the end of the list of search results.
      */
-    startDate?: string;
+    position?: Array<number>;
     /**
-     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     * Number of times this search has been clicked at that position.
      */
-    endDate?: string;
+    clickCount?: number;
+};
+
+type GetClickPositionsResponse = {
     /**
-     * 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/).
+     * List of positions in the search results and clicks associated with this search.
      */
-    tags?: string;
+    positions: Array<ClickPosition>;
 };
-/**
- * Properties for the `getClickPositions` method.
- */
-type GetClickPositionsProps = {
+
+type DailyClickThroughRates = {
     /**
-     * Index name.
+     * 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.
      */
-    index: string;
+    rate: number | null;
     /**
-     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     * Number of clicks associated with this search.
      */
-    startDate?: string;
+    clickCount: number;
     /**
-     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
      */
-    endDate?: string;
+    trackedSearchCount: number;
     /**
-     * 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/).
+     * Date in the format YYYY-MM-DD.
      */
-    tags?: string;
+    date: string;
 };
-/**
- * Properties for the `getClickThroughRate` method.
- */
-type GetClickThroughRateProps = {
+
+type GetClickThroughRateResponse = {
     /**
-     * Index name.
+     * 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.
      */
-    index: string;
+    rate: number | null;
     /**
-     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     * Number of clicks associated with this search.
      */
-    startDate?: string;
+    clickCount: number;
     /**
-     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
      */
-    endDate?: string;
+    trackedSearchCount: number;
     /**
-     * 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/).
+     * Daily click-through rates.
      */
-    tags?: string;
+    dates: Array<DailyClickThroughRates>;
 };
-/**
- * Properties for the `getConversionRate` method.
- */
-type GetConversionRateProps = {
+
+type DailyConversionRates = {
     /**
-     * Index name.
+     * 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.
      */
-    index: string;
+    rate: number | null;
     /**
-     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
      */
-    startDate?: string;
+    trackedSearchCount: number;
     /**
-     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     * Number of conversions from this search.
      */
-    endDate?: string;
+    conversionCount: number;
     /**
-     * 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/).
+     * Date in the format YYYY-MM-DD.
      */
-    tags?: string;
+    date: string;
 };
-/**
- * Properties for the `getNoClickRate` method.
- */
-type GetNoClickRateProps = {
+
+type GetConversionRateResponse = {
     /**
-     * Index name.
+     * 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.
      */
-    index: string;
+    rate: number | null;
     /**
-     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
      */
-    startDate?: string;
+    trackedSearchCount: number;
     /**
-     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     * Number of conversions from this search.
      */
-    endDate?: string;
+    conversionCount: number;
     /**
-     * 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/).
+     * Daily conversion rates.
      */
-    tags?: string;
+    dates: Array<DailyConversionRates>;
 };
-/**
- * Properties for the `getNoResultsRate` method.
- */
-type GetNoResultsRateProps = {
+
+type DailyNoClickRates = {
     /**
-     * Index name.
+     * No click rate, calculated as number of tracked searches without any click divided by the number of tracked searches.
      */
-    index: string;
+    rate: number;
     /**
-     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
      */
-    startDate?: string;
+    count: number;
     /**
-     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     * Number of times this search was returned as a result without any click.
      */
-    endDate?: string;
+    noClickCount: number;
     /**
-     * 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/).
+     * Date in the format YYYY-MM-DD.
      */
-    tags?: string;
+    date: string;
 };
-/**
- * Properties for the `getPurchaseRate` method.
- */
-type GetPurchaseRateProps = {
+
+type GetNoClickRateResponse = {
     /**
-     * Index name.
+     * No click rate, calculated as number of tracked searches without any click divided by the number of tracked searches.
      */
-    index: string;
+    rate: number;
     /**
-     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
      */
-    startDate?: string;
+    count: number;
     /**
-     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     * Number of times this search was returned as a result without any click.
      */
-    endDate?: string;
+    noClickCount: number;
     /**
-     * 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/).
+     * Daily no click rates.
      */
-    tags?: string;
+    dates: Array<DailyNoClickRates>;
 };
-/**
- * Properties for the `getRevenue` method.
- */
-type GetRevenueProps = {
+
+type DailyNoResultsRates = {
     /**
-     * Index name.
+     * Date in the format YYYY-MM-DD.
      */
-    index: string;
+    date: string;
     /**
-     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     * Number of searches without any results.
      */
-    startDate?: string;
+    noResultCount: number;
     /**
-     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     * Number of searches.
      */
-    endDate?: string;
+    count: number;
     /**
-     * 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/).
+     * No results rate, calculated as number of searches with zero results divided by the total number of searches.
      */
-    tags?: string;
+    rate: number;
 };
-/**
- * Properties for the `getSearchesCount` method.
- */
-type GetSearchesCountProps = {
+
+type GetNoResultsRateResponse = {
     /**
-     * Index name.
+     * No results rate, calculated as number of searches with zero results divided by the total number of searches.
      */
-    index: string;
+    rate: number;
     /**
-     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     * Number of searches.
      */
-    startDate?: string;
+    count: number;
     /**
-     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     * Number of searches without any results.
      */
-    endDate?: string;
+    noResultCount: number;
     /**
-     * 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/).
+     * Daily no results rates.
      */
-    tags?: string;
+    dates: Array<DailyNoResultsRates>;
 };
-/**
- * Properties for the `getSearchesNoClicks` method.
- */
-type GetSearchesNoClicksProps = {
-    /**
-     * Index name.
-     */
-    index: string;
-    /**
-     * Start date of the period to analyze, in `YYYY-MM-DD` format.
-     */
-    startDate?: string;
+
+type DailyPurchaseRates = {
     /**
-     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     * 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.
      */
-    endDate?: string;
+    rate: number | null;
     /**
-     * Number of items to return.
+     * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
      */
-    limit?: number;
+    trackedSearchCount: number;
     /**
-     * Position of the first item to return.
+     * Number of purchase events from this search.
      */
-    offset?: number;
+    purchaseCount: number;
     /**
-     * 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/).
+     * Date in the format YYYY-MM-DD.
      */
-    tags?: string;
+    date: string;
 };
-/**
- * Properties for the `getSearchesNoResults` method.
- */
-type GetSearchesNoResultsProps = {
+
+type GetPurchaseRateResponse = {
     /**
-     * Index name.
+     * 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.
      */
-    index: string;
+    rate: number | null;
     /**
-     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
      */
-    startDate?: string;
+    trackedSearchCount: number;
     /**
-     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     * Number of purchase events from this search.
      */
-    endDate?: string;
+    purchaseCount: number;
     /**
-     * Number of items to return.
+     * Daily purchase rates.
      */
-    limit?: number;
+    dates: Array<DailyPurchaseRates>;
+};
+
+/**
+ * Currency code.
+ */
+type CurrencyCode = {
     /**
-     * Position of the first item to return.
+     * Currency code.
      */
-    offset?: number;
+    currency?: 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/).
+     * Revenue associated with this search in this currency.
      */
-    tags?: string;
+    revenue?: number;
 };
-/**
- * Properties for the `getStatus` method.
- */
-type GetStatusProps = {
+
+type DailyRevenue = {
     /**
-     * Index name.
+     * Revenue associated with this search, broken-down by currencies.
      */
-    index: string;
+    currencies: {
+        [key: string]: CurrencyCode;
+    };
+    /**
+     * Date in the format YYYY-MM-DD.
+     */
+    date: string;
 };
-/**
- * Properties for the `getTopCountries` method.
- */
-type GetTopCountriesProps = {
+
+type GetRevenue = {
     /**
-     * Index name.
+     * Revenue associated with this search, broken-down by currencies.
      */
-    index: string;
+    currencies: {
+        [key: string]: CurrencyCode;
+    };
     /**
-     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     * Daily revenue.
      */
-    startDate?: string;
+    dates: Array<DailyRevenue>;
+};
+
+type DailySearches = {
     /**
-     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     * Date in the format YYYY-MM-DD.
      */
-    endDate?: string;
+    date: string;
     /**
-     * Number of items to return.
+     * Number of occurrences.
      */
-    limit?: number;
+    count: number;
+};
+
+type GetSearchesCountResponse = {
     /**
-     * Position of the first item to return.
+     * Number of occurrences.
      */
-    offset?: number;
+    count: number;
     /**
-     * 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/).
+     * Daily number of searches.
      */
-    tags?: string;
+    dates: Array<DailySearches>;
 };
-/**
- * Properties for the `getTopFilterAttributes` method.
- */
-type GetTopFilterAttributesProps = {
+
+type DailySearchesNoClicks = {
     /**
-     * Index name.
+     * Search query.
      */
-    index: string;
+    search: string;
     /**
-     * Search query.
+     * Number of tracked searches.
      */
-    search?: string;
+    count: number;
     /**
-     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     * Number of results (hits).
      */
-    startDate?: string;
+    nbHits: number;
+};
+
+type GetSearchesNoClicksResponse = {
     /**
-     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     * Searches without any clicks.
      */
-    endDate?: string;
+    searches: Array<DailySearchesNoClicks>;
+};
+
+type DailySearchesNoResults = {
     /**
-     * Number of items to return.
+     * Search query.
      */
-    limit?: number;
+    search: string;
     /**
-     * Position of the first item to return.
+     * Number of occurrences.
      */
-    offset?: number;
+    count: number;
     /**
-     * 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/).
+     * Number of searches for this term with applied filters.
      */
-    tags?: string;
+    withFilterCount: number;
 };
-/**
- * Properties for the `getTopFilterForAttribute` method.
- */
-type GetTopFilterForAttributeProps = {
+
+type GetSearchesNoResultsResponse = {
     /**
-     * Attribute name.
+     * Searches without results.
      */
-    attribute: string;
+    searches: Array<DailySearchesNoResults>;
+};
+
+type GetStatusResponse = {
     /**
-     * Index name.
+     * Date and time when the object was updated, in RFC 3339 format.
      */
-    index: string;
+    updatedAt: string | null;
+};
+
+type TopCountry = {
     /**
-     * Search query.
+     * Country code.
      */
-    search?: string;
+    country: string;
     /**
-     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     * Number of occurrences.
      */
-    startDate?: string;
+    count: number;
+};
+
+type GetTopCountriesResponse = {
     /**
-     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     * Countries and number of searches.
      */
-    endDate?: string;
+    countries: Array<TopCountry>;
+};
+
+type GetTopFilterAttribute = {
     /**
-     * Number of items to return.
+     * Attribute name.
      */
-    limit?: number;
+    attribute: string;
     /**
-     * Position of the first item to return.
+     * Number of occurrences.
      */
-    offset?: number;
+    count: number;
+};
+
+type GetTopFilterAttributesResponse = {
     /**
-     * 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/).
+     * Most frequent filters.
      */
-    tags?: string;
+    attributes: Array<GetTopFilterAttribute>;
 };
+
 /**
- * Properties for the `getTopFiltersNoResults` method.
+ * Character that characterizes how the filter is applied.  For example, for a facet filter `facet:value`, `:` is the operator. For a numeric filter `count>50`, `>` is the operator.
  */
-type GetTopFiltersNoResultsProps = {
+type Operator = ':' | '<' | '<=' | '=' | '!=' | '>' | '>=';
+
+type GetTopFilterForAttribute = {
     /**
-     * Index name.
+     * Attribute name.
      */
-    index: string;
+    attribute: string;
+    operator: Operator;
     /**
-     * Search query.
+     * Attribute value.
      */
-    search?: string;
+    value: string;
     /**
-     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     * Number of occurrences.
      */
-    startDate?: string;
+    count: number;
+};
+
+type GetTopFilterForAttributeResponse = {
     /**
-     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     * Filter values for an attribute.
      */
-    endDate?: string;
+    values: Array<GetTopFilterForAttribute>;
+};
+
+type GetTopFiltersNoResultsValue = {
     /**
-     * Number of items to return.
+     * Attribute name.
      */
-    limit?: number;
+    attribute: string;
+    operator: Operator;
     /**
-     * Position of the first item to return.
+     * Attribute value.
      */
-    offset?: number;
+    value: string;
+};
+
+type GetTopFiltersNoResultsValues = {
     /**
-     * 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/).
+     * Number of occurrences.
      */
-    tags?: string;
+    count: number;
+    /**
+     * Filters with no results.
+     */
+    values: Array<GetTopFiltersNoResultsValue>;
 };
-/**
- * Properties for the `getTopHits` method.
- */
-type GetTopHitsProps = {
+
+type GetTopFiltersNoResultsResponse = {
     /**
-     * Index name.
+     * 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.
      */
-    index: string;
+    values: Array<GetTopFiltersNoResultsValues> | null;
+};
+
+type TopHit = {
     /**
-     * Search query.
+     * Object ID of a record that\'s returned as a search result.
      */
-    search?: string;
+    hit: string;
     /**
-     * Whether to include metrics related to click and conversion events in the response.
+     * Number of occurrences.
      */
-    clickAnalytics?: boolean;
+    count: number;
+};
+
+type TopHitsResponse = {
     /**
-     * Whether to include revenue-related metrics in the response.  If true, metrics related to click and conversion events are also included in the response.
+     * Most frequent search results.
      */
-    revenueAnalytics?: boolean;
+    hits: Array<TopHit>;
+};
+
+type TopHitWithAnalytics = {
     /**
-     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     * Object ID of a record that\'s returned as a search result.
      */
-    startDate?: string;
+    hit: string;
     /**
-     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     * Number of occurrences.
      */
-    endDate?: string;
+    count: number;
     /**
-     * Number of items to return.
+     * 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.
      */
-    limit?: number;
+    clickThroughRate: number | null;
     /**
-     * Position of the first item to return.
+     * 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.
      */
-    offset?: number;
+    conversionRate: number | null;
     /**
-     * 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/).
+     * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
      */
-    tags?: string;
-};
-/**
- * Properties for the `getTopSearches` method.
- */
-type GetTopSearchesProps = {
+    trackedHitCount: number;
     /**
-     * Index name.
+     * Number of clicks associated with this search.
      */
-    index: string;
+    clickCount: number;
     /**
-     * Whether to include metrics related to click and conversion events in the response.
+     * Number of conversions from this search.
      */
-    clickAnalytics?: boolean;
+    conversionCount: number;
+};
+
+type TopHitsResponseWithAnalytics = {
     /**
-     * Whether to include revenue-related metrics in the response.  If true, metrics related to click and conversion events are also included in the response.
+     * Most frequent search results with click and conversion metrics.
      */
-    revenueAnalytics?: boolean;
+    hits: Array<TopHitWithAnalytics>;
+};
+
+type TopHitWithRevenueAnalytics = {
     /**
-     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     * Object ID of a record that\'s returned as a search result.
      */
-    startDate?: string;
+    hit: string;
     /**
-     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     * Number of occurrences.
      */
-    endDate?: string;
+    count: number;
     /**
-     * Attribute by which to order the response items.  If the `clickAnalytics` parameter is false, only `searchCount` is available.
+     * 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.
      */
-    orderBy?: OrderBy;
+    clickThroughRate: number | null;
     /**
-     * Sorting direction of the results: ascending or descending.
+     * 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.
      */
-    direction?: Direction;
+    conversionRate: number | null;
     /**
-     * Number of items to return.
+     * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
      */
-    limit?: number;
+    trackedHitCount: number;
     /**
-     * Position of the first item to return.
+     * Number of clicks associated with this search.
      */
-    offset?: number;
+    clickCount: number;
     /**
-     * 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/).
+     * Number of conversions from this search.
      */
-    tags?: string;
-};
-/**
- * Properties for the `getUsersCount` method.
- */
-type GetUsersCountProps = {
+    conversionCount: number;
     /**
-     * Index name.
+     * 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.
      */
-    index: string;
+    addToCartRate: number | null;
     /**
-     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     * Number of add-to-cart events from this search.
      */
-    startDate?: string;
+    addToCartCount: number;
     /**
-     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     * 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.
      */
-    endDate?: string;
+    purchaseRate: number | null;
     /**
-     * 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/).
+     * Number of purchase events from this search.
      */
-    tags?: string;
+    purchaseCount: number;
+    /**
+     * Revenue associated with this search, broken-down by currencies.
+     */
+    currencies: {
+        [key: string]: CurrencyCode;
+    };
 };
 
-type DailyAddToCartRates = {
+type TopHitsResponseWithRevenueAnalytics = {
     /**
-     * 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.
+     * Most frequent search results with click, conversion, and revenue metrics.
      */
-    rate: number | null;
+    hits: Array<TopHitWithRevenueAnalytics>;
+};
+
+type GetTopHitsResponse = TopHitsResponse | TopHitsResponseWithAnalytics | TopHitsResponseWithRevenueAnalytics;
+
+type TopSearch = {
     /**
-     * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
+     * Search query.
      */
-    trackedSearchCount: number;
+    search: string;
     /**
-     * Number of add-to-cart events from this search.
+     * Number of searches.
      */
-    addToCartCount: number;
+    count: number;
     /**
-     * Date in the format YYYY-MM-DD.
+     * Number of results (hits).
      */
-    date: string;
+    nbHits: number;
 };
 
-type GetAddToCartRateResponse = {
+type TopSearchesResponse = {
     /**
-     * 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.
+     * Most popular searches and their number of search results (hits).
      */
-    rate: number | null;
+    searches: Array<TopSearch>;
+};
+
+type TopSearchWithAnalytics = {
     /**
-     * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
+     * Search query.
      */
-    trackedSearchCount: number;
+    search: string;
     /**
-     * Number of add-to-cart events from this search.
+     * Number of searches.
      */
-    addToCartCount: number;
+    count: number;
     /**
-     * Daily add-to-cart rates.
+     * 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.
      */
-    dates: DailyAddToCartRates[];
-};
-
-type DailyAverageClicks = {
+    clickThroughRate: number | null;
     /**
      * 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;
+    averageClickPosition: number | null;
     /**
-     * Number of clicks associated with this search.
+     * List of positions in the search results and clicks associated with this search.
      */
-    clickCount: number;
+    clickPositions: Array<ClickPosition>;
     /**
-     * Date in the format YYYY-MM-DD.
+     * 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.
      */
-    date: string;
-};
-
-type GetAverageClickPositionResponse = {
+    conversionRate: number | null;
     /**
-     * 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.
+     * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
      */
-    average: number | null;
+    trackedSearchCount: number;
     /**
      * Number of clicks associated with this search.
      */
     clickCount: number;
     /**
-     * Daily average click positions.
-     */
-    dates: DailyAverageClicks[];
-};
-
-/**
- * Click position.
- */
-type ClickPosition = {
-    /**
-     * Range of positions in the search results, using the pattern `[start,end]`.  For positions 11 and up, click events are summed over the specified range. `-1` indicates the end of the list of search results.
+     * Number of conversions from this search.
      */
-    position?: number[];
+    conversionCount: number;
     /**
-     * Number of times this search has been clicked at that position.
+     * Number of results (hits).
      */
-    clickCount?: number;
+    nbHits: number;
 };
 
-type GetClickPositionsResponse = {
+type TopSearchesResponseWithAnalytics = {
     /**
-     * List of positions in the search results and clicks associated with this search.
+     * Most popular searches and their associated click and conversion metrics.
      */
-    positions: ClickPosition[];
+    searches: Array<TopSearchWithAnalytics>;
 };
 
-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;
+type TopSearchWithRevenueAnalytics = {
     /**
-     * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
+     * Search query.
      */
-    trackedSearchCount: number;
+    search: string;
     /**
-     * Date in the format YYYY-MM-DD.
+     * Number of searches.
      */
-    date: string;
-};
-
-type GetClickThroughRateResponse = {
+    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.
      */
-    rate: number | null;
-    /**
-     * Number of clicks associated with this search.
-     */
-    clickCount: number;
+    clickThroughRate: number | null;
     /**
-     * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
+     * 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.
      */
-    trackedSearchCount: number;
+    averageClickPosition: number | null;
     /**
-     * Daily click-through rates.
+     * List of positions in the search results and clicks associated with this search.
      */
-    dates: DailyClickThroughRates[];
-};
-
-type DailyConversionRates = {
+    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.
      */
-    rate: number | null;
+    conversionRate: number | null;
     /**
      * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
      */
     trackedSearchCount: number;
+    /**
+     * Number of clicks associated with this search.
+     */
+    clickCount: number;
     /**
      * Number of conversions from this search.
      */
     conversionCount: number;
     /**
-     * Date in the format YYYY-MM-DD.
+     * Number of results (hits).
      */
-    date: string;
-};
-
-type GetConversionRateResponse = {
+    nbHits: number;
     /**
-     * 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.
+     * Revenue associated with this search, broken-down by currencies.
      */
-    rate: number | null;
+    currencies: {
+        [key: string]: CurrencyCode;
+    };
     /**
-     * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
-     */
-    trackedSearchCount: number;
-    /**
-     * Number of conversions from this search.
+     * 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.
      */
-    conversionCount: number;
+    addToCartRate: number | null;
     /**
-     * Daily conversion rates.
+     * Number of add-to-cart events from this search.
      */
-    dates: DailyConversionRates[];
-};
-
-type DailyNoClickRates = {
+    addToCartCount: number;
     /**
-     * No click rate, calculated as number of tracked searches without any click divided by the number of tracked searches.
+     * 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;
+    purchaseRate: number | null;
     /**
-     * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
+     * Number of purchase events from this search.
      */
-    count: number;
+    purchaseCount: number;
+};
+
+type TopSearchesResponseWithRevenueAnalytics = {
     /**
-     * Number of times this search was returned as a result without any click.
+     * Most popular searches, including their click and revenue metrics.
      */
-    noClickCount: number;
+    searches: Array<TopSearchWithRevenueAnalytics>;
+};
+
+type GetTopSearchesResponse = TopSearchesResponse | TopSearchesResponseWithAnalytics | TopSearchesResponseWithRevenueAnalytics;
+
+type DailyUsers = {
     /**
      * Date in the format YYYY-MM-DD.
      */
     date: string;
+    /**
+     * Number of unique users.
+     */
+    count: number;
 };
 
-type GetNoClickRateResponse = {
+type GetUsersCountResponse = {
     /**
-     * No click rate, calculated as number of tracked searches without any click divided by the number of tracked searches.
+     * Number of unique users.
      */
-    rate: number;
+    count: number;
     /**
-     * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
+     * Daily number of unique users.
      */
-    count: number;
+    dates: Array<DailyUsers>;
+};
+
+type Direction = 'asc' | 'desc';
+
+/**
+ * Attribute by which to order the response items.  If the `clickAnalytics` parameter is false, only `searchCount` is available.
+ */
+type OrderBy = 'searchCount' | 'clickThroughRate' | 'conversionRate' | 'averageClickPosition';
+
+/**
+ * Properties for the `customDelete` method.
+ */
+type CustomDeleteProps = {
     /**
-     * Number of times this search was returned as a result without any click.
+     * Path of the endpoint, anything after \"/1\" must be specified.
      */
-    noClickCount: number;
+    path: string;
     /**
-     * Daily no click rates.
+     * Query parameters to apply to the current query.
      */
-    dates: DailyNoClickRates[];
+    parameters?: {
+        [key: string]: any;
+    };
 };
-
-type DailyNoResultsRates = {
+/**
+ * Properties for the `customGet` method.
+ */
+type CustomGetProps = {
     /**
-     * Date in the format YYYY-MM-DD.
+     * Path of the endpoint, anything after \"/1\" must be specified.
      */
-    date: string;
+    path: string;
     /**
-     * Number of searches without any results.
+     * Query parameters to apply to the current query.
      */
-    noResultCount: number;
+    parameters?: {
+        [key: string]: any;
+    };
+};
+/**
+ * Properties for the `customPost` method.
+ */
+type CustomPostProps = {
     /**
-     * Number of searches.
+     * Path of the endpoint, anything after \"/1\" must be specified.
      */
-    count: number;
+    path: string;
     /**
-     * No results rate, calculated as number of searches with zero results divided by the total number of searches.
+     * Query parameters to apply to the current query.
      */
-    rate: number;
-};
-
-type GetNoResultsRateResponse = {
+    parameters?: {
+        [key: string]: any;
+    };
     /**
-     * No results rate, calculated as number of searches with zero results divided by the total number of searches.
+     * Parameters to send with the custom request.
      */
-    rate: number;
+    body?: Record<string, unknown>;
+};
+/**
+ * Properties for the `customPut` method.
+ */
+type CustomPutProps = {
     /**
-     * Number of searches.
+     * Path of the endpoint, anything after \"/1\" must be specified.
      */
-    count: number;
+    path: string;
     /**
-     * Number of searches without any results.
+     * Query parameters to apply to the current query.
      */
-    noResultCount: number;
+    parameters?: {
+        [key: string]: any;
+    };
     /**
-     * Daily no results rates.
+     * Parameters to send with the custom request.
      */
-    dates: DailyNoResultsRates[];
+    body?: Record<string, unknown>;
 };
-
-type DailyPurchaseRates = {
+/**
+ * Properties for the `getAddToCartRate` method.
+ */
+type GetAddToCartRateProps = {
     /**
-     * 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.
+     * Index name.
      */
-    rate: number | null;
+    index: string;
     /**
-     * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
-    trackedSearchCount: number;
+    startDate?: string;
     /**
-     * Number of purchase events from this search.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
-    purchaseCount: number;
+    endDate?: string;
     /**
-     * Date in the format YYYY-MM-DD.
+     * 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/).
      */
-    date: string;
+    tags?: string;
 };
-
-type GetPurchaseRateResponse = {
+/**
+ * Properties for the `getAverageClickPosition` method.
+ */
+type GetAverageClickPositionProps = {
     /**
-     * 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.
+     * Index name.
      */
-    rate: number | null;
+    index: string;
     /**
-     * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
-    trackedSearchCount: number;
+    startDate?: string;
     /**
-     * Number of purchase events from this search.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
-    purchaseCount: number;
+    endDate?: string;
     /**
-     * Daily purchase rates.
+     * 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/).
      */
-    dates: DailyPurchaseRates[];
+    tags?: string;
 };
-
 /**
- * Currency code.
+ * Properties for the `getClickPositions` method.
  */
-type CurrencyCode = {
+type GetClickPositionsProps = {
     /**
-     * Currency code.
+     * Index name.
      */
-    currency?: string;
+    index: string;
     /**
-     * Revenue associated with this search in this currency.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
-    revenue?: number;
-};
-
-type DailyRevenue = {
+    startDate?: string;
     /**
-     * Revenue associated with this search, broken-down by currencies.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
-    currencies: Record<string, CurrencyCode>;
+    endDate?: string;
     /**
-     * Date in the format YYYY-MM-DD.
+     * 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/).
      */
-    date: string;
+    tags?: string;
 };
-
-type GetRevenue = {
+/**
+ * Properties for the `getClickThroughRate` method.
+ */
+type GetClickThroughRateProps = {
     /**
-     * Revenue associated with this search, broken-down by currencies.
+     * Index name.
      */
-    currencies: Record<string, CurrencyCode>;
+    index: string;
     /**
-     * Daily revenue.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
-    dates: DailyRevenue[];
-};
-
-type DailySearches = {
+    startDate?: string;
     /**
-     * Date in the format YYYY-MM-DD.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
-    date: string;
+    endDate?: string;
     /**
-     * Number of occurrences.
+     * 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/).
      */
-    count: number;
+    tags?: string;
 };
-
-type GetSearchesCountResponse = {
-    /**
-     * Number of occurrences.
-     */
-    count: number;
+/**
+ * Properties for the `getConversionRate` method.
+ */
+type GetConversionRateProps = {
     /**
-     * Daily number of searches.
+     * Index name.
      */
-    dates: DailySearches[];
-};
-
-type DailySearchesNoClicks = {
+    index: string;
     /**
-     * Search query.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
-    search: string;
+    startDate?: string;
     /**
-     * Number of tracked searches.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
-    count: number;
+    endDate?: string;
     /**
-     * Number of results (hits).
+     * 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/).
      */
-    nbHits: number;
+    tags?: string;
 };
-
-type GetSearchesNoClicksResponse = {
+/**
+ * Properties for the `getNoClickRate` method.
+ */
+type GetNoClickRateProps = {
     /**
-     * Searches without any clicks.
+     * Index name.
      */
-    searches: DailySearchesNoClicks[];
-};
-
-type DailySearchesNoResults = {
+    index: string;
     /**
-     * Search query.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
-    search: string;
+    startDate?: string;
     /**
-     * Number of occurrences.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
-    count: number;
+    endDate?: string;
     /**
-     * Number of searches for this term with applied filters.
+     * 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/).
      */
-    withFilterCount: number;
+    tags?: string;
 };
-
-type GetSearchesNoResultsResponse = {
+/**
+ * Properties for the `getNoResultsRate` method.
+ */
+type GetNoResultsRateProps = {
     /**
-     * Searches without results.
+     * Index name.
      */
-    searches: DailySearchesNoResults[];
-};
-
-type GetStatusResponse = {
+    index: string;
     /**
-     * Date and time when the object was updated, in RFC 3339 format.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
-    updatedAt: string | null;
-};
-
-type TopCountry = {
+    startDate?: string;
     /**
-     * Country code.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
-    country: string;
+    endDate?: string;
     /**
-     * Number of occurrences.
+     * 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/).
      */
-    count: number;
+    tags?: string;
 };
-
-type GetTopCountriesResponse = {
+/**
+ * Properties for the `getPurchaseRate` method.
+ */
+type GetPurchaseRateProps = {
     /**
-     * Countries and number of searches.
+     * Index name.
      */
-    countries: TopCountry[];
-};
-
-type GetTopFilterAttribute = {
+    index: string;
     /**
-     * Attribute name.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
-    attribute: string;
+    startDate?: string;
     /**
-     * Number of occurrences.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
-    count: number;
-};
-
-type GetTopFilterAttributesResponse = {
+    endDate?: string;
     /**
-     * Most frequent filters.
+     * 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/).
      */
-    attributes: GetTopFilterAttribute[];
+    tags?: string;
 };
-
 /**
- * Character that characterizes how the filter is applied.  For example, for a facet filter `facet:value`, `:` is the operator. For a numeric filter `count>50`, `>` is the operator.
+ * Properties for the `getRevenue` method.
  */
-type Operator = ':' | '!=' | '<' | '<=' | '=' | '>' | '>=';
-
-type GetTopFilterForAttribute = {
+type GetRevenueProps = {
     /**
-     * Attribute name.
+     * Index name.
      */
-    attribute: string;
-    operator: Operator;
+    index: string;
     /**
-     * Attribute value.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
-    value: string;
+    startDate?: string;
     /**
-     * Number of occurrences.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
-    count: number;
-};
-
-type GetTopFilterForAttributeResponse = {
+    endDate?: string;
     /**
-     * Filter values for an attribute.
+     * 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/).
      */
-    values: GetTopFilterForAttribute[];
+    tags?: string;
 };
-
-type GetTopFiltersNoResultsValue = {
+/**
+ * Properties for the `getSearchesCount` method.
+ */
+type GetSearchesCountProps = {
     /**
-     * Attribute name.
+     * Index name.
      */
-    attribute: string;
-    operator: Operator;
+    index: string;
     /**
-     * Attribute value.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
-    value: string;
-};
-
-type GetTopFiltersNoResultsValues = {
+    startDate?: string;
     /**
-     * Number of occurrences.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
-    count: number;
+    endDate?: string;
     /**
-     * Filters with no results.
+     * 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/).
      */
-    values: GetTopFiltersNoResultsValue[];
+    tags?: string;
 };
-
-type GetTopFiltersNoResultsResponse = {
+/**
+ * Properties for the `getSearchesNoClicks` method.
+ */
+type GetSearchesNoClicksProps = {
     /**
-     * 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.
+     * Index name.
      */
-    values: GetTopFiltersNoResultsValues[] | null;
-};
-
-type TopHit = {
+    index: string;
     /**
-     * Object ID of a record that\'s returned as a search result.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
-    hit: string;
+    startDate?: string;
     /**
-     * Number of occurrences.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
-    count: number;
-};
-
-type TopHitsResponse = {
+    endDate?: string;
     /**
-     * Most frequent search results.
+     * Number of items to return.  Combined with the `offset` parameter, only the first 1000 items can be retrieved.
      */
-    hits: TopHit[];
-};
-
-type TopHitWithAnalytics = {
+    limit?: number;
     /**
-     * Object ID of a record that\'s returned as a search result.
+     * Position of the first item to return.  Combined with the `limit` parameter, only the first 1000 items can be retrieved.
      */
-    hit: string;
+    offset?: number;
     /**
-     * Number of occurrences.
+     * 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/).
      */
-    count: number;
+    tags?: string;
+};
+/**
+ * Properties for the `getSearchesNoResults` method.
+ */
+type GetSearchesNoResultsProps = {
     /**
-     * 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.
+     * Index name.
      */
-    clickThroughRate: number | null;
+    index: string;
     /**
-     * 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.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
-    conversionRate: number | null;
+    startDate?: string;
     /**
-     * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
-    trackedHitCount: number;
+    endDate?: string;
     /**
-     * Number of clicks associated with this search.
+     * Number of items to return.  Combined with the `offset` parameter, only the first 1000 items can be retrieved.
      */
-    clickCount: number;
+    limit?: number;
     /**
-     * Number of conversions from this search.
+     * Position of the first item to return.  Combined with the `limit` parameter, only the first 1000 items can be retrieved.
      */
-    conversionCount: number;
+    offset?: number;
+    /**
+     * 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;
 };
-
-type TopHitsResponseWithAnalytics = {
+/**
+ * Properties for the `getStatus` method.
+ */
+type GetStatusProps = {
     /**
-     * Most frequent search results with click and conversion metrics.
+     * Index name.
      */
-    hits: TopHitWithAnalytics[];
+    index: string;
 };
-
-type TopHitWithRevenueAnalytics = {
+/**
+ * Properties for the `getTopCountries` method.
+ */
+type GetTopCountriesProps = {
+    /**
+     * Index name.
+     */
+    index: string;
     /**
-     * Object ID of a record that\'s returned as a search result.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
-    hit: string;
+    startDate?: string;
     /**
-     * Number of occurrences.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
-    count: number;
+    endDate?: string;
     /**
-     * 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.
+     * Number of items to return.  Combined with the `offset` parameter, only the first 1000 items can be retrieved.
      */
-    clickThroughRate: number | null;
+    limit?: number;
     /**
-     * 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.
+     * Position of the first item to return.  Combined with the `limit` parameter, only the first 1000 items can be retrieved.
      */
-    conversionRate: number | null;
+    offset?: number;
     /**
-     * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
+     * 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/).
      */
-    trackedHitCount: number;
+    tags?: string;
+};
+/**
+ * Properties for the `getTopFilterAttributes` method.
+ */
+type GetTopFilterAttributesProps = {
     /**
-     * Number of clicks associated with this search.
+     * Index name.
      */
-    clickCount: number;
+    index: string;
     /**
-     * Number of conversions from this search.
+     * Search query.
      */
-    conversionCount: number;
+    search?: string;
     /**
-     * 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.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
-    addToCartRate: number | null;
+    startDate?: string;
     /**
-     * Number of add-to-cart events from this search.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
-    addToCartCount: number;
+    endDate?: string;
     /**
-     * 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.
+     * Number of items to return.  Combined with the `offset` parameter, only the first 1000 items can be retrieved.
      */
-    purchaseRate: number | null;
+    limit?: number;
     /**
-     * Number of purchase events from this search.
+     * Position of the first item to return.  Combined with the `limit` parameter, only the first 1000 items can be retrieved.
      */
-    purchaseCount: number;
+    offset?: number;
     /**
-     * Revenue associated with this search, broken-down by currencies.
+     * 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/).
      */
-    currencies: Record<string, CurrencyCode>;
+    tags?: string;
 };
-
-type TopHitsResponseWithRevenueAnalytics = {
+/**
+ * Properties for the `getTopFilterForAttribute` method.
+ */
+type GetTopFilterForAttributeProps = {
     /**
-     * Most frequent search results with click, conversion, and revenue metrics.
+     * Attribute name.
      */
-    hits: TopHitWithRevenueAnalytics[];
-};
-
-type GetTopHitsResponse = TopHitsResponse | TopHitsResponseWithAnalytics | TopHitsResponseWithRevenueAnalytics;
-
-type TopSearch = {
+    attribute: string;
     /**
-     * Search query.
+     * Index name.
      */
-    search: string;
+    index: string;
     /**
-     * Number of searches.
+     * Search query.
      */
-    count: number;
+    search?: string;
     /**
-     * Number of results (hits).
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
-    nbHits: number;
-};
-
-type TopSearchesResponse = {
+    startDate?: string;
     /**
-     * Most popular searches and their number of search results (hits).
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
-    searches: TopSearch[];
-};
-
-type TopSearchWithAnalytics = {
+    endDate?: string;
     /**
-     * Search query.
+     * Number of items to return.  Combined with the `offset` parameter, only the first 1000 items can be retrieved.
      */
-    search: string;
+    limit?: number;
     /**
-     * Number of searches.
+     * Position of the first item to return.  Combined with the `limit` parameter, only the first 1000 items can be retrieved.
      */
-    count: number;
+    offset?: 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.
+     * 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/).
      */
-    clickThroughRate: number | null;
+    tags?: string;
+};
+/**
+ * Properties for the `getTopFiltersNoResults` method.
+ */
+type GetTopFiltersNoResultsProps = {
     /**
-     * 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.
+     * Index name.
      */
-    averageClickPosition: number | null;
+    index: string;
     /**
-     * List of positions in the search results and clicks associated with this search.
+     * Search query.
      */
-    clickPositions: ClickPosition[];
+    search?: string;
     /**
-     * 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.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
-    conversionRate: number | null;
+    startDate?: string;
     /**
-     * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
-    trackedSearchCount: number;
+    endDate?: string;
     /**
-     * Number of clicks associated with this search.
+     * Number of items to return.  Combined with the `offset` parameter, only the first 1000 items can be retrieved.
      */
-    clickCount: number;
+    limit?: number;
     /**
-     * Number of conversions from this search.
+     * Position of the first item to return.  Combined with the `limit` parameter, only the first 1000 items can be retrieved.
      */
-    conversionCount: number;
+    offset?: number;
     /**
-     * Number of results (hits).
+     * 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/).
      */
-    nbHits: number;
+    tags?: string;
 };
-
-type TopSearchesResponseWithAnalytics = {
+/**
+ * Properties for the `getTopHits` method.
+ */
+type GetTopHitsProps = {
     /**
-     * Most popular searches and their associated click and conversion metrics.
+     * Index name.
      */
-    searches: TopSearchWithAnalytics[];
-};
-
-type TopSearchWithRevenueAnalytics = {
+    index: string;
     /**
      * Search query.
      */
-    search: string;
+    search?: string;
     /**
-     * Number of searches.
+     * Whether to include metrics related to click and conversion events in the response.
      */
-    count: number;
+    clickAnalytics?: boolean;
     /**
-     * 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.
+     * Whether to include revenue-related metrics in the response.  If true, metrics related to click and conversion events are also included in the response.
      */
-    clickThroughRate: number | null;
+    revenueAnalytics?: boolean;
     /**
-     * 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.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
-    averageClickPosition: number | null;
+    startDate?: string;
     /**
-     * List of positions in the search results and clicks associated with this search.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
-    clickPositions: ClickPosition[];
+    endDate?: string;
     /**
-     * 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.
+     * Number of items to return.  Combined with the `offset` parameter, only the first 1000 items can be retrieved.
      */
-    conversionRate: number | null;
+    limit?: number;
     /**
-     * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
+     * Position of the first item to return.  Combined with the `limit` parameter, only the first 1000 items can be retrieved.
      */
-    trackedSearchCount: number;
+    offset?: number;
     /**
-     * Number of clicks associated with this search.
+     * 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/).
      */
-    clickCount: number;
+    tags?: string;
+};
+/**
+ * Properties for the `getTopSearches` method.
+ */
+type GetTopSearchesProps = {
     /**
-     * Number of conversions from this search.
+     * Index name.
      */
-    conversionCount: number;
+    index: string;
     /**
-     * Number of results (hits).
+     * Whether to include metrics related to click and conversion events in the response.
      */
-    nbHits: number;
+    clickAnalytics?: boolean;
     /**
-     * Revenue associated with this search, broken-down by currencies.
+     * Whether to include revenue-related metrics in the response.  If true, metrics related to click and conversion events are also included in the response.
      */
-    currencies: Record<string, CurrencyCode>;
+    revenueAnalytics?: boolean;
     /**
-     * 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.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
-    addToCartRate: number | null;
+    startDate?: string;
     /**
-     * Number of add-to-cart events from this search.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
-    addToCartCount: number;
+    endDate?: string;
     /**
-     * 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.
+     * Attribute by which to order the response items.  If the `clickAnalytics` parameter is false, only `searchCount` is available.
      */
-    purchaseRate: number | null;
+    orderBy?: OrderBy;
     /**
-     * Number of purchase events from this search.
+     * Sorting direction of the results: ascending or descending.
      */
-    purchaseCount: number;
-};
-
-type TopSearchesResponseWithRevenueAnalytics = {
+    direction?: Direction;
     /**
-     * Most popular searches, including their click and revenue metrics.
+     * Number of items to return.  Combined with the `offset` parameter, only the first 1000 items can be retrieved.
      */
-    searches: TopSearchWithRevenueAnalytics[];
-};
-
-type GetTopSearchesResponse = TopSearchesResponse | TopSearchesResponseWithAnalytics | TopSearchesResponseWithRevenueAnalytics;
-
-type DailyUsers = {
+    limit?: number;
     /**
-     * Date in the format YYYY-MM-DD.
+     * Position of the first item to return.  Combined with the `limit` parameter, only the first 1000 items can be retrieved.
      */
-    date: string;
+    offset?: number;
     /**
-     * Number of unique users.
+     * 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/).
      */
-    count: number;
+    tags?: string;
 };
-
-type GetUsersCountResponse = {
+/**
+ * Properties for the `getUsersCount` method.
+ */
+type GetUsersCountProps = {
     /**
-     * Number of unique users.
+     * Index name.
      */
-    count: number;
+    index: string;
     /**
-     * Daily number of unique users.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    startDate?: string;
+    /**
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    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/).
      */
-    dates: DailyUsers[];
+    tags?: string;
 };
 
-declare const apiClientVersion = "5.7.0";
+declare const apiClientVersion = "5.8.0";
 declare const REGIONS: readonly ["de", "us"];
 type Region = (typeof REGIONS)[number];
 declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }: CreateClientOptions & {
@@ -1386,7 +1402,6 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
     }): void;
     /**
      * This method allow you to send requests to the Algolia REST API.
-     *
      * @param customDelete - The customDelete object.
      * @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
      * @param customDelete.parameters - Query parameters to apply to the current query.
@@ -1395,7 +1410,6 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
     customDelete({ path, parameters }: CustomDeleteProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
     /**
      * This method allow you to send requests to the Algolia REST API.
-     *
      * @param customGet - The customGet object.
      * @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
      * @param customGet.parameters - Query parameters to apply to the current query.
@@ -1404,7 +1418,6 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
     customGet({ path, parameters }: CustomGetProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
     /**
      * This method allow you to send requests to the Algolia REST API.
-     *
      * @param customPost - The customPost object.
      * @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
      * @param customPost.parameters - Query parameters to apply to the current query.
@@ -1414,7 +1427,6 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
     customPost({ path, parameters, body }: CustomPostProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
     /**
      * This method allow you to send requests to the Algolia REST API.
-     *
      * @param customPut - The customPut object.
      * @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
      * @param customPut.parameters - Query parameters to apply to the current query.
@@ -1426,8 +1438,7 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
      * 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.
-     *
+     *  - analytics
      * @param getAddToCartRate - The getAddToCartRate object.
      * @param getAddToCartRate.index - Index name.
      * @param getAddToCartRate.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
@@ -1440,8 +1451,7 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
      * 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.
-     *
+     *  - analytics
      * @param getAverageClickPosition - The getAverageClickPosition object.
      * @param getAverageClickPosition.index - Index name.
      * @param getAverageClickPosition.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
@@ -1454,8 +1464,7 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
      * 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.
-     *
+     *  - analytics
      * @param getClickPositions - The getClickPositions object.
      * @param getClickPositions.index - Index name.
      * @param getClickPositions.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
@@ -1468,8 +1477,7 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
      * 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.
-     *
+     *  - analytics
      * @param getClickThroughRate - The getClickThroughRate object.
      * @param getClickThroughRate.index - Index name.
      * @param getClickThroughRate.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
@@ -1482,8 +1490,7 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
      * 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.
-     *
+     *  - analytics
      * @param getConversionRate - The getConversionRate object.
      * @param getConversionRate.index - Index name.
      * @param getConversionRate.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
@@ -1496,8 +1503,7 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
      * 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.
-     *
+     *  - analytics
      * @param getNoClickRate - The getNoClickRate object.
      * @param getNoClickRate.index - Index name.
      * @param getNoClickRate.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
@@ -1510,8 +1516,7 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
      * 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.
-     *
+     *  - analytics
      * @param getNoResultsRate - The getNoResultsRate object.
      * @param getNoResultsRate.index - Index name.
      * @param getNoResultsRate.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
@@ -1524,8 +1529,7 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
      * 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.
-     *
+     *  - analytics
      * @param getPurchaseRate - The getPurchaseRate object.
      * @param getPurchaseRate.index - Index name.
      * @param getPurchaseRate.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
@@ -1538,8 +1542,7 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
      * 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.
-     *
+     *  - analytics
      * @param getRevenue - The getRevenue object.
      * @param getRevenue.index - Index name.
      * @param getRevenue.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
@@ -1552,8 +1555,7 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
      * 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.
-     *
+     *  - analytics
      * @param getSearchesCount - The getSearchesCount object.
      * @param getSearchesCount.index - Index name.
      * @param getSearchesCount.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
@@ -1566,14 +1568,13 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
      * Retrieves the most popular searches that didn\'t lead to any clicks, from the 1,000 most frequent searches.
      *
      * Required API Key ACLs:
-     * - analytics.
-     *
+     *  - analytics
      * @param getSearchesNoClicks - The getSearchesNoClicks object.
      * @param getSearchesNoClicks.index - Index name.
      * @param getSearchesNoClicks.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
      * @param getSearchesNoClicks.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
-     * @param getSearchesNoClicks.limit - Number of items to return.
-     * @param getSearchesNoClicks.offset - Position of the first item to return.
+     * @param getSearchesNoClicks.limit - Number of items to return.  Combined with the `offset` parameter, only the first 1000 items can be retrieved.
+     * @param getSearchesNoClicks.offset - Position of the first item to return.  Combined with the `limit` parameter, only the first 1000 items can be retrieved.
      * @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.
      */
@@ -1582,14 +1583,13 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
      * Retrieves the most popular searches that didn\'t return any results.
      *
      * Required API Key ACLs:
-     * - analytics.
-     *
+     *  - analytics
      * @param getSearchesNoResults - The getSearchesNoResults object.
      * @param getSearchesNoResults.index - Index name.
      * @param getSearchesNoResults.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
      * @param getSearchesNoResults.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
-     * @param getSearchesNoResults.limit - Number of items to return.
-     * @param getSearchesNoResults.offset - Position of the first item to return.
+     * @param getSearchesNoResults.limit - Number of items to return.  Combined with the `offset` parameter, only the first 1000 items can be retrieved.
+     * @param getSearchesNoResults.offset - Position of the first item to return.  Combined with the `limit` parameter, only the first 1000 items can be retrieved.
      * @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.
      */
@@ -1598,8 +1598,7 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
      * 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.
-     *
+     *  - analytics
      * @param getStatus - The getStatus object.
      * @param getStatus.index - Index name.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -1609,14 +1608,13 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
      * Retrieves the countries with the most searches to your index.
      *
      * Required API Key ACLs:
-     * - analytics.
-     *
+     *  - analytics
      * @param getTopCountries - The getTopCountries object.
      * @param getTopCountries.index - Index name.
      * @param getTopCountries.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
      * @param getTopCountries.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
-     * @param getTopCountries.limit - Number of items to return.
-     * @param getTopCountries.offset - Position of the first item to return.
+     * @param getTopCountries.limit - Number of items to return.  Combined with the `offset` parameter, only the first 1000 items can be retrieved.
+     * @param getTopCountries.offset - Position of the first item to return.  Combined with the `limit` parameter, only the first 1000 items can be retrieved.
      * @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.
      */
@@ -1625,15 +1623,14 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
      * 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.
-     *
+     *  - analytics
      * @param getTopFilterAttributes - The getTopFilterAttributes object.
      * @param getTopFilterAttributes.index - Index name.
      * @param getTopFilterAttributes.search - Search query.
      * @param getTopFilterAttributes.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
      * @param getTopFilterAttributes.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
-     * @param getTopFilterAttributes.limit - Number of items to return.
-     * @param getTopFilterAttributes.offset - Position of the first item to return.
+     * @param getTopFilterAttributes.limit - Number of items to return.  Combined with the `offset` parameter, only the first 1000 items can be retrieved.
+     * @param getTopFilterAttributes.offset - Position of the first item to return.  Combined with the `limit` parameter, only the first 1000 items can be retrieved.
      * @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.
      */
@@ -1642,16 +1639,15 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
      * 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.
-     *
+     *  - analytics
      * @param getTopFilterForAttribute - The getTopFilterForAttribute object.
      * @param getTopFilterForAttribute.attribute - Attribute name.
      * @param getTopFilterForAttribute.index - Index name.
      * @param getTopFilterForAttribute.search - Search query.
      * @param getTopFilterForAttribute.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
      * @param getTopFilterForAttribute.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
-     * @param getTopFilterForAttribute.limit - Number of items to return.
-     * @param getTopFilterForAttribute.offset - Position of the first item to return.
+     * @param getTopFilterForAttribute.limit - Number of items to return.  Combined with the `offset` parameter, only the first 1000 items can be retrieved.
+     * @param getTopFilterForAttribute.offset - Position of the first item to return.  Combined with the `limit` parameter, only the first 1000 items can be retrieved.
      * @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.
      */
@@ -1660,15 +1656,14 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
      * 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.
-     *
+     *  - analytics
      * @param getTopFiltersNoResults - The getTopFiltersNoResults object.
      * @param getTopFiltersNoResults.index - Index name.
      * @param getTopFiltersNoResults.search - Search query.
      * @param getTopFiltersNoResults.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
      * @param getTopFiltersNoResults.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
-     * @param getTopFiltersNoResults.limit - Number of items to return.
-     * @param getTopFiltersNoResults.offset - Position of the first item to return.
+     * @param getTopFiltersNoResults.limit - Number of items to return.  Combined with the `offset` parameter, only the first 1000 items can be retrieved.
+     * @param getTopFiltersNoResults.offset - Position of the first item to return.  Combined with the `limit` parameter, only the first 1000 items can be retrieved.
      * @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.
      */
@@ -1677,8 +1672,7 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
      * Retrieves the object IDs of the most frequent search results.
      *
      * Required API Key ACLs:
-     * - analytics.
-     *
+     *  - analytics
      * @param getTopHits - The getTopHits object.
      * @param getTopHits.index - Index name.
      * @param getTopHits.search - Search query.
@@ -1686,8 +1680,8 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
      * @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 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.
-     * @param getTopHits.offset - Position of the first item to return.
+     * @param getTopHits.limit - Number of items to return.  Combined with the `offset` parameter, only the first 1000 items can be retrieved.
+     * @param getTopHits.offset - Position of the first item to return.  Combined with the `limit` parameter, only the first 1000 items can be retrieved.
      * @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.
      */
@@ -1696,8 +1690,7 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
      * Returns the most popular search terms.
      *
      * Required API Key ACLs:
-     * - analytics.
-     *
+     *  - 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.
@@ -1706,8 +1699,8 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
      * @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.
      * @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.limit - Number of items to return.  Combined with the `offset` parameter, only the first 1000 items can be retrieved.
+     * @param getTopSearches.offset - Position of the first item to return.  Combined with the `limit` parameter, only the first 1000 items can be retrieved.
      * @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.
      */
@@ -1716,8 +1709,7 @@ declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOptio
      * 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.
-     *
+     *  - analytics
      * @param getUsersCount - The getUsersCount object.
      * @param getUsersCount.index - Index name.
      * @param getUsersCount.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.