@algolia/client-analytics 5.2.5 → 5.3.1

package/dist/browser.d.ts

@@ -1,1399 +1,1742 @@
 import * as _algolia_client_common from '@algolia/client-common';
-import { ClientOptions } from '@algolia/client-common';
+import { CreateClientOptions, RequestOptions, ClientOptions } from '@algolia/client-common';
+
+type Direction = 'asc' | 'desc';
 
 /**
- * Click position.
+ * Attribute by which to order the response items.  If the `clickAnalytics` parameter is false, only `searchCount` is available.
  */
-type ClickPosition = {
+type OrderBy = 'averageClickPosition' | 'clickThroughRate' | 'conversionRate' | 'searchCount';
+
+/**
+ * Properties for the `customDelete` method.
+ */
+type CustomDeleteProps = {
     /**
-     * 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.
+     * Path of the endpoint, anything after \"/1\" must be specified.
      */
-    position?: number[];
+    path: string;
     /**
-     * Number of times this search has been clicked at that position.
+     * Query parameters to apply to the current query.
      */
-    clickCount?: number;
+    parameters?: Record<string, any>;
 };
-
 /**
- * Currency code.
+ * Properties for the `customGet` method.
  */
-type CurrencyCode = {
+type CustomGetProps = {
     /**
-     * Currency code.
+     * Path of the endpoint, anything after \"/1\" must be specified.
      */
-    currency?: string;
+    path: string;
     /**
-     * Revenue associated with this search in this currency.
+     * Query parameters to apply to the current query.
      */
-    revenue?: number;
+    parameters?: Record<string, any>;
 };
-
-type DailyAddToCartRates = {
-    /**
-     * Add-to-cart rate, calculated as number of tracked searches with at least one add-to-cart event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
-     */
-    rate: number | null;
+/**
+ * Properties for the `customPost` method.
+ */
+type CustomPostProps = {
     /**
-     * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
+     * Path of the endpoint, anything after \"/1\" must be specified.
      */
-    trackedSearchCount: number;
+    path: string;
     /**
-     * Number of add-to-cart events from this search.
+     * Query parameters to apply to the current query.
      */
-    addToCartCount: number;
+    parameters?: Record<string, any>;
     /**
-     * Date in the format YYYY-MM-DD.
+     * Parameters to send with the custom request.
      */
-    date: string;
+    body?: Record<string, unknown>;
 };
-
-type DailyAverageClicks = {
+/**
+ * Properties for the `customPut` method.
+ */
+type CustomPutProps = {
     /**
-     * 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.
+     * Path of the endpoint, anything after \"/1\" must be specified.
      */
-    average: number | null;
+    path: string;
     /**
-     * Number of clicks associated with this search.
+     * Query parameters to apply to the current query.
      */
-    clickCount: number;
+    parameters?: Record<string, any>;
     /**
-     * Date in the format YYYY-MM-DD.
+     * Parameters to send with the custom request.
      */
-    date: string;
+    body?: Record<string, unknown>;
 };
-
-type DailyClickThroughRates = {
+/**
+ * Properties for the `getAddToCartRate` method.
+ */
+type GetAddToCartRateProps = {
     /**
-     * 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.
      */
-    rate: number | null;
+    index: string;
     /**
-     * Number of clicks associated with this search.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
-    clickCount: number;
+    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;
     /**
-     * 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 DailyConversionRates = {
+/**
+ * Properties for the `getAverageClickPosition` method.
+ */
+type GetAverageClickPositionProps = {
     /**
-     * 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 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 conversions from this search.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
-    conversionCount: 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 DailyNoClickRates = {
+/**
+ * Properties for the `getClickPositions` method.
+ */
+type GetClickPositionsProps = {
     /**
-     * No click rate, calculated as number of tracked searches without any click divided by the number of tracked searches.
+     * Index name.
      */
-    rate: number;
+    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.
      */
-    count: number;
+    startDate?: string;
     /**
-     * Number of times this search was returned as a result without any click.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
-    noClickCount: 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 DailyNoResultsRates = {
+/**
+ * Properties for the `getClickThroughRate` method.
+ */
+type GetClickThroughRateProps = {
     /**
-     * Date in the format YYYY-MM-DD.
+     * Index name.
      */
-    date: string;
+    index: string;
     /**
-     * Number of searches without any results.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
-    noResultCount: number;
+    startDate?: string;
     /**
-     * Number of searches.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
-    count: number;
+    endDate?: string;
     /**
-     * No results rate, calculated as number of searches with zero results divided by the total number of searches.
+     * 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/).
      */
-    rate: number;
+    tags?: string;
 };
-
-type DailyPurchaseRates = {
+/**
+ * Properties for the `getConversionRate` method.
+ */
+type GetConversionRateProps = {
     /**
-     * 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 DailyRevenue = {
+/**
+ * Properties for the `getNoClickRate` method.
+ */
+type GetNoClickRateProps = {
     /**
-     * Revenue associated with this search, broken-down by currencies.
+     * Index name.
      */
-    currencies: Record<string, CurrencyCode>;
+    index: string;
     /**
-     * Date in the format YYYY-MM-DD.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
-    date: string;
-};
-
-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 DailySearchesNoClicks = {
+/**
+ * Properties for the `getNoResultsRate` method.
+ */
+type GetNoResultsRateProps = {
     /**
-     * Search query.
+     * Index name.
      */
-    search: string;
+    index: string;
     /**
-     * Number of tracked searches.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
-    count: number;
+    startDate?: string;
     /**
-     * Number of results (hits).
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
-    nbHits: number;
-};
-
-type DailySearchesNoResults = {
+    endDate?: string;
     /**
-     * Search query.
+     * 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/).
      */
-    search: string;
+    tags?: string;
+};
+/**
+ * Properties for the `getPurchaseRate` method.
+ */
+type GetPurchaseRateProps = {
     /**
-     * Number of occurrences.
+     * Index name.
      */
-    count: number;
+    index: string;
     /**
-     * Number of searches for this term with applied filters.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
-    withFilterCount: number;
-};
-
-type DailyUsers = {
+    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 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 Direction = 'asc' | 'desc';
-
 /**
- * Error.
+ * Properties for the `getRevenue` method.
  */
-type ErrorBase = Record<string, any> & {
-    message?: string;
-};
-
-type GetAddToCartRateResponse = {
+type GetRevenueProps = {
     /**
-     * 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 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 add-to-cart events from this search.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
-    addToCartCount: number;
+    endDate?: string;
     /**
-     * Daily add-to-cart 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: DailyAddToCartRates[];
+    tags?: string;
 };
-
-type GetAverageClickPositionResponse = {
+/**
+ * Properties for the `getSearchesCount` method.
+ */
+type GetSearchesCountProps = {
     /**
-     * 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.
      */
-    average: number | null;
+    index: string;
     /**
-     * Number of clicks associated with this search.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
-    clickCount: number;
+    startDate?: string;
     /**
-     * Daily average click positions.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
-    dates: DailyAverageClicks[];
-};
-
-type GetClickPositionsResponse = {
+    endDate?: string;
     /**
-     * List of positions in the search results and 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/).
      */
-    positions: ClickPosition[];
+    tags?: string;
 };
-
-type GetClickThroughRateResponse = {
+/**
+ * Properties for the `getSearchesNoClicks` method.
+ */
+type GetSearchesNoClicksProps = {
     /**
-     * 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.
      */
-    rate: number | null;
+    index: string;
     /**
-     * Number of clicks associated with this search.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
-    clickCount: number;
+    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;
     /**
-     * Daily click-through rates.
+     * Number of items to return.
      */
-    dates: DailyClickThroughRates[];
-};
-
-type GetConversionRateResponse = {
+    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.
      */
-    rate: 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/).
      */
-    trackedSearchCount: number;
+    tags?: string;
+};
+/**
+ * Properties for the `getSearchesNoResults` method.
+ */
+type GetSearchesNoResultsProps = {
     /**
-     * Number of conversions from this search.
+     * Index name.
      */
-    conversionCount: number;
+    index: string;
     /**
-     * Daily conversion rates.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
-    dates: DailyConversionRates[];
-};
-
-type GetNoClickRateResponse = {
+    startDate?: string;
     /**
-     * No click rate, calculated as number of tracked searches without any click divided by the number of tracked searches.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
-    rate: number;
+    endDate?: string;
     /**
-     * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
+     * Number of items to return.
      */
-    count: number;
+    limit?: number;
     /**
-     * Number of times this search was returned as a result without any click.
+     * Position of the first item to return.
      */
-    noClickCount: number;
+    offset?: number;
     /**
-     * Daily no click 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: DailyNoClickRates[];
+    tags?: string;
 };
-
-type GetNoResultsRateResponse = {
+/**
+ * Properties for the `getStatus` method.
+ */
+type GetStatusProps = {
     /**
-     * No results rate, calculated as number of searches with zero results divided by the total number of searches.
+     * Index name.
      */
-    rate: number;
+    index: string;
+};
+/**
+ * Properties for the `getTopCountries` method.
+ */
+type GetTopCountriesProps = {
     /**
-     * Number of searches.
+     * Index name.
      */
-    count: number;
+    index: string;
     /**
-     * Number of searches without any results.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
-    noResultCount: number;
+    startDate?: string;
     /**
-     * Daily no results rates.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
-    dates: DailyNoResultsRates[];
-};
-
-type GetPurchaseRateResponse = {
+    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.
      */
-    rate: 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.
      */
-    trackedSearchCount: number;
+    offset?: number;
     /**
-     * Number of purchase events from 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/).
      */
-    purchaseCount: number;
+    tags?: string;
+};
+/**
+ * Properties for the `getTopFilterAttributes` method.
+ */
+type GetTopFilterAttributesProps = {
     /**
-     * Daily purchase rates.
+     * Index name.
      */
-    dates: DailyPurchaseRates[];
-};
-
-type GetRevenue = {
+    index: string;
     /**
-     * Revenue associated with this search, broken-down by currencies.
+     * Search query.
      */
-    currencies: Record<string, CurrencyCode>;
+    search?: string;
     /**
-     * Daily revenue.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
-    dates: DailyRevenue[];
-};
-
-type GetSearchesCountResponse = {
+    startDate?: string;
     /**
-     * Number of occurrences.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
-    count: number;
+    endDate?: string;
     /**
-     * Daily number of searches.
+     * Number of items to return.
      */
-    dates: DailySearches[];
-};
-
-type GetSearchesNoClicksResponse = {
+    limit?: number;
     /**
-     * Searches without any clicks.
+     * Position of the first item to return.
      */
-    searches: DailySearchesNoClicks[];
-};
-
-type GetSearchesNoResultsResponse = {
+    offset?: number;
     /**
-     * Searches without 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/).
      */
-    searches: DailySearchesNoResults[];
+    tags?: string;
 };
-
-type GetStatusResponse = {
+/**
+ * Properties for the `getTopFilterForAttribute` method.
+ */
+type GetTopFilterForAttributeProps = {
     /**
-     * Date and time when the object was updated, in RFC 3339 format.
+     * Attribute name.
      */
-    updatedAt: string | null;
-};
-
-type TopCountry = {
+    attribute: string;
     /**
-     * Country code.
+     * Index name.
      */
-    country: string;
+    index: string;
     /**
-     * Number of occurrences.
+     * Search query.
      */
-    count: number;
-};
-
-type GetTopCountriesResponse = {
+    search?: string;
     /**
-     * Countries and number of searches.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
-    countries: TopCountry[];
-};
-
-type GetTopFilterAttribute = {
+    startDate?: string;
     /**
-     * Attribute name.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
-    attribute: string;
+    endDate?: string;
     /**
-     * Number of occurrences.
+     * Number of items to return.
      */
-    count: number;
-};
-
-type GetTopFilterAttributesResponse = {
+    limit?: number;
     /**
-     * Most frequent filters.
+     * Position of the first item to return.
      */
-    attributes: GetTopFilterAttribute[];
+    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;
 };
-
 /**
- * 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 `getTopFiltersNoResults` method.
  */
-type Operator = ':' | '!=' | '<' | '<=' | '=' | '>' | '>=';
-
-type GetTopFilterForAttribute = {
-    /**
-     * Attribute name.
-     */
-    attribute: string;
-    operator: Operator;
-    /**
-     * Attribute value.
-     */
-    value: string;
+type GetTopFiltersNoResultsProps = {
     /**
-     * Number of occurrences.
+     * Index name.
      */
-    count: number;
-};
-
-type GetTopFilterForAttributeResponse = {
+    index: string;
     /**
-     * Filter values for an attribute.
+     * Search query.
      */
-    values: GetTopFilterForAttribute[];
-};
-
-type GetTopFiltersNoResultsValue = {
+    search?: string;
     /**
-     * Attribute name.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
-    attribute: string;
-    operator: Operator;
+    startDate?: string;
     /**
-     * Attribute value.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
-    value: string;
-};
-
-type GetTopFiltersNoResultsValues = {
+    endDate?: string;
     /**
-     * Number of occurrences.
+     * Number of items to return.
      */
-    count: number;
+    limit?: number;
     /**
-     * Filters with no results.
+     * Position of the first item to return.
      */
-    values: GetTopFiltersNoResultsValue[];
-};
-
-type GetTopFiltersNoResultsResponse = {
+    offset?: number;
     /**
-     * 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.
+     * 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: GetTopFiltersNoResultsValues[] | null;
+    tags?: string;
 };
-
-type TopHit = {
+/**
+ * Properties for the `getTopHits` method.
+ */
+type GetTopHitsProps = {
     /**
-     * Object ID of a record that\'s returned as a search result.
+     * Index name.
      */
-    hit: string;
+    index: string;
     /**
-     * Number of occurrences.
+     * Search query.
      */
-    count: number;
-};
-
-type TopHitsResponse = {
+    search?: string;
     /**
-     * Most frequent search results.
+     * Whether to include metrics related to click and conversion events in the response.
      */
-    hits: TopHit[];
-};
-
-type TopHitWithAnalytics = {
+    clickAnalytics?: boolean;
     /**
-     * Object ID of a record that\'s returned as a search result.
+     * Whether to include revenue-related metrics in the response.  If true, metrics related to click and conversion events are also included in the response.
      */
-    hit: string;
+    revenueAnalytics?: boolean;
     /**
-     * Number of occurrences.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
-    count: number;
+    startDate?: 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.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
-    clickThroughRate: number | null;
+    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.
      */
-    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.
      */
-    trackedHitCount: 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;
-};
-
-type TopHitsResponseWithAnalytics = {
+    index: string;
     /**
-     * Most frequent search results with click and conversion metrics.
+     * Whether to include metrics related to click and conversion events in the response.
      */
-    hits: TopHitWithAnalytics[];
-};
-
-type TopHitWithRevenueAnalytics = {
+    clickAnalytics?: boolean;
     /**
-     * Object ID of a record that\'s returned as a search result.
+     * Whether to include revenue-related metrics in the response.  If true, metrics related to click and conversion events are also included in the response.
      */
-    hit: string;
+    revenueAnalytics?: boolean;
     /**
-     * Number of occurrences.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
-    count: number;
+    startDate?: 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.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
-    clickThroughRate: number | null;
+    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.
+     * Attribute by which to order the response items.  If the `clickAnalytics` parameter is false, only `searchCount` is available.
      */
-    conversionRate: number | null;
+    orderBy?: OrderBy;
     /**
-     * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
+     * Sorting direction of the results: ascending or descending.
      */
-    trackedHitCount: number;
+    direction?: Direction;
     /**
-     * Number of clicks associated with this search.
+     * Number of items to return.
      */
-    clickCount: number;
+    limit?: number;
     /**
-     * Number of conversions from this search.
+     * Position of the first item to return.
      */
-    conversionCount: number;
+    offset?: number;
     /**
-     * Add-to-cart rate, calculated as number of tracked searches with at least one add-to-cart event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
+     * 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/).
      */
-    addToCartRate: number | null;
+    tags?: string;
+};
+/**
+ * Properties for the `getUsersCount` method.
+ */
+type GetUsersCountProps = {
     /**
-     * Number of add-to-cart events from this search.
+     * Index name.
      */
-    addToCartCount: number;
+    index: 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.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
-    purchaseRate: number | null;
+    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;
     /**
-     * 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 = {
+type DailyAddToCartRates = {
     /**
-     * Most frequent search results with click, conversion, and revenue metrics.
+     * 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.
      */
-    hits: TopHitWithRevenueAnalytics[];
-};
-
-type GetTopHitsResponse = TopHitsResponse | TopHitsResponseWithAnalytics | TopHitsResponseWithRevenueAnalytics;
-
-type TopSearch = {
+    rate: number | null;
     /**
-     * Search query.
+     * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
      */
-    search: string;
+    trackedSearchCount: number;
     /**
-     * Number of searches.
+     * Number of add-to-cart events from this search.
      */
-    count: number;
+    addToCartCount: number;
     /**
-     * Number of results (hits).
+     * Date in the format YYYY-MM-DD.
      */
-    nbHits: number;
+    date: string;
 };
 
-type TopSearchesResponse = {
+type GetAddToCartRateResponse = {
     /**
-     * Most popular searches and their number of search results (hits).
+     * 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.
      */
-    searches: TopSearch[];
-};
-
-type TopSearchWithAnalytics = {
+    rate: number | null;
     /**
-     * Search query.
+     * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
      */
-    search: string;
+    trackedSearchCount: number;
     /**
-     * Number of searches.
+     * Number of add-to-cart events from this search.
      */
-    count: number;
+    addToCartCount: 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.
+     * Daily add-to-cart rates.
      */
-    clickThroughRate: number | null;
+    dates: DailyAddToCartRates[];
+};
+
+type DailyAverageClicks = {
     /**
      * Average position of a clicked search result in the list of search results. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
      */
-    averageClickPosition: number | null;
+    average: number | null;
     /**
-     * List of positions in the search results and clicks associated with this search.
+     * Number of clicks associated with this search.
      */
-    clickPositions: ClickPosition[];
+    clickCount: 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.
+     * Date in the format YYYY-MM-DD.
      */
-    conversionRate: number | null;
+    date: string;
+};
+
+type GetAverageClickPositionResponse = {
     /**
-     * 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;
+    average: number | null;
     /**
      * Number of clicks associated with this search.
      */
     clickCount: number;
     /**
-     * Number of conversions from this search.
-     */
-    conversionCount: number;
-    /**
-     * Number of results (hits).
+     * Daily average click positions.
      */
-    nbHits: number;
+    dates: DailyAverageClicks[];
 };
 
-type TopSearchesResponseWithAnalytics = {
+/**
+ * Click position.
+ */
+type ClickPosition = {
     /**
-     * Most popular searches and their associated click and conversion metrics.
+     * 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.
      */
-    searches: TopSearchWithAnalytics[];
-};
-
-type TopSearchWithRevenueAnalytics = {
+    position?: number[];
     /**
-     * Search query.
+     * Number of times this search has been clicked at that position.
      */
-    search: string;
+    clickCount?: number;
+};
+
+type GetClickPositionsResponse = {
     /**
-     * Number of searches.
+     * List of positions in the search results and clicks associated with this search.
      */
-    count: number;
+    positions: ClickPosition[];
+};
+
+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.
      */
-    clickThroughRate: number | null;
+    rate: 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 clicks associated with this search.
      */
-    averageClickPosition: number | null;
+    clickCount: number;
     /**
-     * List of positions in the search results and clicks associated with this search.
+     * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
      */
-    clickPositions: ClickPosition[];
+    trackedSearchCount: 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.
+     * Date in the format YYYY-MM-DD.
      */
-    conversionRate: number | null;
+    date: string;
+};
+
+type GetClickThroughRateResponse = {
     /**
-     * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
+     * 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.
      */
-    trackedSearchCount: number;
+    rate: number | null;
     /**
      * Number of clicks associated with this search.
      */
     clickCount: number;
     /**
-     * Number of conversions from this search.
-     */
-    conversionCount: number;
-    /**
-     * Number of results (hits).
+     * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
      */
-    nbHits: number;
+    trackedSearchCount: number;
     /**
-     * Revenue associated with this search, broken-down by currencies.
+     * Daily click-through rates.
      */
-    currencies: Record<string, CurrencyCode>;
+    dates: DailyClickThroughRates[];
+};
+
+type DailyConversionRates = {
     /**
-     * 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.
+     * 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.
      */
-    addToCartRate: number | null;
+    rate: number | null;
     /**
-     * Number of add-to-cart events from this search.
+     * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
      */
-    addToCartCount: number;
+    trackedSearchCount: number;
     /**
-     * Purchase rate, calculated as number of tracked searches with at least one purchase event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
+     * Number of conversions from this search.
      */
-    purchaseRate: number | null;
+    conversionCount: number;
     /**
-     * Number of purchase events from this search.
+     * Date in the format YYYY-MM-DD.
      */
-    purchaseCount: number;
+    date: string;
 };
 
-type TopSearchesResponseWithRevenueAnalytics = {
+type GetConversionRateResponse = {
     /**
-     * Most popular searches, including their click and revenue metrics.
+     * 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.
      */
-    searches: TopSearchWithRevenueAnalytics[];
-};
-
-type GetTopSearchesResponse = TopSearchesResponse | TopSearchesResponseWithAnalytics | TopSearchesResponseWithRevenueAnalytics;
-
-type GetUsersCountResponse = {
+    rate: number | null;
     /**
-     * Number of unique users.
+     * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
      */
-    count: number;
+    trackedSearchCount: number;
     /**
-     * Daily number of unique users.
+     * Number of conversions from this search.
      */
-    dates: DailyUsers[];
+    conversionCount: number;
+    /**
+     * Daily conversion rates.
+     */
+    dates: DailyConversionRates[];
 };
 
-/**
- * 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 DailyNoClickRates = {
     /**
-     * Path of the endpoint, anything after \"/1\" must be specified.
+     * No click rate, calculated as number of tracked searches without any click divided by the number of tracked searches.
      */
-    path: string;
+    rate: number;
     /**
-     * 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 = {
+    count: number;
     /**
-     * Path of the endpoint, anything after \"/1\" must be specified.
+     * Number of times this search was returned as a result without any click.
      */
-    path: string;
+    noClickCount: 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 GetNoClickRateResponse = {
     /**
-     * Path of the endpoint, anything after \"/1\" must be specified.
+     * No click rate, calculated as number of tracked searches without any click divided by the number of tracked searches.
      */
-    path: string;
+    rate: number;
     /**
-     * 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>;
+    count: number;
     /**
-     * Parameters to send with the custom request.
+     * Number of times this search was returned as a result without any click.
      */
-    body?: Record<string, unknown>;
+    noClickCount: number;
+    /**
+     * Daily no click rates.
+     */
+    dates: DailyNoClickRates[];
 };
-/**
- * Properties for the `customPut` method.
- */
-type CustomPutProps = {
+
+type DailyNoResultsRates = {
     /**
-     * Path of the endpoint, anything after \"/1\" must be specified.
+     * Date in the format YYYY-MM-DD.
      */
-    path: string;
+    date: string;
     /**
-     * Query parameters to apply to the current query.
+     * Number of searches without any results.
      */
-    parameters?: Record<string, any>;
+    noResultCount: number;
     /**
-     * Parameters to send with the custom request.
+     * Number of searches.
      */
-    body?: Record<string, unknown>;
+    count: number;
+    /**
+     * No results rate, calculated as number of searches with zero results divided by the total number of searches.
+     */
+    rate: number;
 };
-/**
- * Properties for the `getAddToCartRate` method.
- */
-type GetAddToCartRateProps = {
+
+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: DailyNoResultsRates[];
 };
-/**
- * Properties for the `getAverageClickPosition` method.
- */
-type GetAverageClickPositionProps = {
+
+type DailyPurchaseRates = {
     /**
-     * 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;
     /**
-     * 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 `getClickPositions` method.
- */
-type GetClickPositionsProps = {
+
+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;
     /**
-     * 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 purchase rates.
      */
-    tags?: string;
+    dates: DailyPurchaseRates[];
 };
+
 /**
- * Properties for the `getClickThroughRate` method.
+ * Currency code.
  */
-type GetClickThroughRateProps = {
+type CurrencyCode = {
     /**
-     * Index name.
+     * Currency code.
      */
-    index: string;
+    currency?: string;
     /**
-     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     * Revenue associated with this search in this currency.
      */
-    startDate?: string;
+    revenue?: number;
+};
+
+type DailyRevenue = {
     /**
-     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     * Revenue associated with this search, broken-down by currencies.
      */
-    endDate?: string;
+    currencies: Record<string, CurrencyCode>;
     /**
-     * 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 `getConversionRate` method.
- */
-type GetConversionRateProps = {
-    /**
-     * Index name.
-     */
-    index: string;
-    /**
-     * Start date of the period to analyze, in `YYYY-MM-DD` format.
-     */
-    startDate?: string;
+
+type GetRevenue = {
     /**
-     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     * Revenue associated with this search, broken-down by currencies.
      */
-    endDate?: string;
+    currencies: Record<string, CurrencyCode>;
     /**
-     * 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 revenue.
      */
-    tags?: string;
+    dates: DailyRevenue[];
 };
-/**
- * Properties for the `getNoClickRate` method.
- */
-type GetNoClickRateProps = {
+
+type DailySearches = {
     /**
-     * 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 occurrences.
      */
-    startDate?: string;
+    count: number;
+};
+
+type GetSearchesCountResponse = {
     /**
-     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     * Number of occurrences.
      */
-    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/).
+     * Daily number of searches.
      */
-    tags?: string;
+    dates: DailySearches[];
 };
-/**
- * Properties for the `getNoResultsRate` method.
- */
-type GetNoResultsRateProps = {
-    /**
-     * Index name.
-     */
-    index: string;
+
+type DailySearchesNoClicks = {
     /**
-     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     * Search query.
      */
-    startDate?: string;
+    search: string;
     /**
-     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     * Number of tracked 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/).
+     * Number of results (hits).
      */
-    tags?: string;
+    nbHits: number;
 };
-/**
- * Properties for the `getPurchaseRate` method.
- */
-type GetPurchaseRateProps = {
+
+type GetSearchesNoClicksResponse = {
     /**
-     * Index name.
+     * Searches without any clicks.
      */
-    index: string;
+    searches: DailySearchesNoClicks[];
+};
+
+type DailySearchesNoResults = {
     /**
-     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     * Search query.
      */
-    startDate?: string;
+    search: string;
     /**
-     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     * Number of occurrences.
      */
-    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/).
+     * Number of searches for this term with applied filters.
      */
-    tags?: string;
+    withFilterCount: number;
 };
-/**
- * Properties for the `getRevenue` method.
- */
-type GetRevenueProps = {
+
+type GetSearchesNoResultsResponse = {
     /**
-     * Index name.
+     * Searches without results.
      */
-    index: string;
+    searches: DailySearchesNoResults[];
+};
+
+type GetStatusResponse = {
     /**
-     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     * Date and time when the object was updated, in RFC 3339 format.
      */
-    startDate?: string;
+    updatedAt: string | null;
+};
+
+type TopCountry = {
     /**
-     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     * Country code.
      */
-    endDate?: string;
+    country: 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/).
+     * Number of occurrences.
      */
-    tags?: string;
+    count: number;
 };
-/**
- * Properties for the `getSearchesCount` method.
- */
-type GetSearchesCountProps = {
+
+type GetTopCountriesResponse = {
     /**
-     * Index name.
+     * Countries and number of searches.
      */
-    index: string;
+    countries: TopCountry[];
+};
+
+type GetTopFilterAttribute = {
     /**
-     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     * Attribute name.
      */
-    startDate?: string;
+    attribute: string;
     /**
-     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     * Number of occurrences.
      */
-    endDate?: string;
+    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: GetTopFilterAttribute[];
 };
+
 /**
- * Properties for the `getSearchesNoClicks` 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 GetSearchesNoClicksProps = {
+type Operator = ':' | '!=' | '<' | '<=' | '=' | '>' | '>=';
+
+type GetTopFilterForAttribute = {
     /**
-     * Index name.
+     * Attribute name.
      */
-    index: string;
+    attribute: string;
+    operator: Operator;
     /**
-     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     * Attribute value.
      */
-    startDate?: string;
+    value: string;
     /**
-     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     * Number of occurrences.
      */
-    endDate?: string;
+    count: number;
+};
+
+type GetTopFilterForAttributeResponse = {
     /**
-     * Number of items to return.
+     * Filter values for an attribute.
      */
-    limit?: number;
+    values: GetTopFilterForAttribute[];
+};
+
+type GetTopFiltersNoResultsValue = {
     /**
-     * Position of the first item to return.
+     * Attribute name.
      */
-    offset?: number;
+    attribute: string;
+    operator: Operator;
     /**
-     * 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/).
+     * Attribute value.
      */
-    tags?: string;
+    value: string;
 };
-/**
- * Properties for the `getSearchesNoResults` method.
- */
-type GetSearchesNoResultsProps = {
+
+type GetTopFiltersNoResultsValues = {
     /**
-     * Index name.
+     * Number of occurrences.
      */
-    index: string;
+    count: number;
     /**
-     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     * Filters with no results.
      */
-    startDate?: string;
+    values: GetTopFiltersNoResultsValue[];
+};
+
+type GetTopFiltersNoResultsResponse = {
     /**
-     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     * 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.
      */
-    endDate?: string;
+    values: GetTopFiltersNoResultsValues[] | null;
+};
+
+type TopHit = {
     /**
-     * Number of items to return.
+     * Object ID of a record that\'s returned as a search result.
      */
-    limit?: number;
+    hit: string;
     /**
-     * Position of the first item to return.
+     * Number of occurrences.
      */
-    offset?: number;
+    count: number;
+};
+
+type TopHitsResponse = {
     /**
-     * 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 search results.
      */
-    tags?: string;
+    hits: TopHit[];
 };
-/**
- * Properties for the `getStatus` method.
- */
-type GetStatusProps = {
+
+type TopHitWithAnalytics = {
     /**
-     * Index name.
+     * Object ID of a record that\'s returned as a search result.
      */
-    index: string;
-};
-/**
- * Properties for the `getTopCountries` method.
- */
-type GetTopCountriesProps = {
+    hit: string;
     /**
-     * Index name.
+     * Number of occurrences.
      */
-    index: string;
+    count: number;
     /**
-     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     * 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.
      */
-    startDate?: string;
+    clickThroughRate: number | null;
     /**
-     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     * 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.
      */
-    endDate?: string;
+    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;
+    conversionCount: number;
 };
-/**
- * Properties for the `getTopFilterAttributes` method.
- */
-type GetTopFilterAttributesProps = {
+
+type TopHitsResponseWithAnalytics = {
     /**
-     * Index name.
+     * Most frequent search results with click and conversion metrics.
      */
-    index: string;
+    hits: TopHitWithAnalytics[];
+};
+
+type TopHitWithRevenueAnalytics = {
+    /**
+     * Object ID of a record that\'s returned as a search result.
+     */
+    hit: string;
+    /**
+     * Number of occurrences.
+     */
+    count: number;
     /**
-     * Search query.
+     * 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.
      */
-    search?: string;
+    clickThroughRate: number | null;
     /**
-     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     * 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.
      */
-    startDate?: string;
+    conversionRate: number | null;
     /**
-     * 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;
+    trackedHitCount: number;
     /**
-     * Number of items to return.
+     * Number of clicks associated with this search.
      */
-    limit?: number;
+    clickCount: number;
     /**
-     * Position of the first item to return.
+     * Number of conversions from this search.
      */
-    offset?: number;
+    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/).
+     * 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.
      */
-    tags?: string;
-};
-/**
- * Properties for the `getTopFilterForAttribute` method.
- */
-type GetTopFilterForAttributeProps = {
+    addToCartRate: number | null;
     /**
-     * Attribute name.
+     * Number of add-to-cart events from this search.
      */
-    attribute: string;
+    addToCartCount: number;
     /**
-     * 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;
+    purchaseRate: number | null;
     /**
-     * Search query.
+     * Number of purchase events from this search.
      */
-    search?: string;
+    purchaseCount: number;
     /**
-     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     * Revenue associated with this search, broken-down by currencies.
      */
-    startDate?: string;
+    currencies: Record<string, CurrencyCode>;
+};
+
+type TopHitsResponseWithRevenueAnalytics = {
     /**
-     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     * Most frequent search results with click, conversion, and revenue metrics.
      */
-    endDate?: string;
+    hits: TopHitWithRevenueAnalytics[];
+};
+
+type GetTopHitsResponse = TopHitsResponse | TopHitsResponseWithAnalytics | TopHitsResponseWithRevenueAnalytics;
+
+type TopSearch = {
     /**
-     * Number of items to return.
+     * Search query.
      */
-    limit?: number;
+    search: string;
     /**
-     * Position of the first item to return.
+     * Number of searches.
      */
-    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 results (hits).
      */
-    tags?: string;
+    nbHits: number;
 };
-/**
- * Properties for the `getTopFiltersNoResults` method.
- */
-type GetTopFiltersNoResultsProps = {
+
+type TopSearchesResponse = {
     /**
-     * Index name.
+     * Most popular searches and their number of search results (hits).
      */
-    index: string;
+    searches: TopSearch[];
+};
+
+type TopSearchWithAnalytics = {
     /**
      * Search query.
      */
-    search?: string;
+    search: string;
     /**
-     * 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.
+     * 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.
      */
-    endDate?: string;
+    clickThroughRate: number | null;
     /**
-     * Number of items to return.
+     * 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.
      */
-    limit?: number;
+    averageClickPosition: number | null;
     /**
-     * Position of the first item to return.
+     * List of positions in the search results and clicks associated with this search.
      */
-    offset?: number;
+    clickPositions: ClickPosition[];
     /**
-     * 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/).
+     * 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.
      */
-    tags?: string;
-};
-/**
- * Properties for the `getTopHits` method.
- */
-type GetTopHitsProps = {
+    conversionRate: number | null;
     /**
-     * Index name.
+     * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
      */
-    index: string;
+    trackedSearchCount: number;
     /**
-     * Search query.
+     * Number of clicks associated with this search.
      */
-    search?: 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;
     /**
-     * Whether to include revenue-related metrics in the response.  If true, metrics related to click and conversion events are also included in the response.
+     * Number of results (hits).
      */
-    revenueAnalytics?: boolean;
+    nbHits: number;
+};
+
+type TopSearchesResponseWithAnalytics = {
     /**
-     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     * Most popular searches and their associated click and conversion metrics.
      */
-    startDate?: string;
+    searches: TopSearchWithAnalytics[];
+};
+
+type TopSearchWithRevenueAnalytics = {
     /**
-     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     * Search query.
      */
-    endDate?: string;
+    search: string;
     /**
-     * Number of items to return.
+     * Number of searches.
      */
-    limit?: number;
+    count: number;
     /**
-     * Position of the first item 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.
      */
-    offset?: number;
+    clickThroughRate: 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/).
+     * 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.
      */
-    tags?: string;
-};
-/**
- * Properties for the `getTopSearches` method.
- */
-type GetTopSearchesProps = {
+    averageClickPosition: number | null;
     /**
-     * Index name.
+     * List of positions in the search results and clicks associated with this search.
      */
-    index: string;
+    clickPositions: ClickPosition[];
     /**
-     * Whether to include metrics related to click and conversion events in the response.
+     * 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.
      */
-    clickAnalytics?: boolean;
+    conversionRate: number | null;
     /**
-     * Whether to include revenue-related metrics in the response.  If true, metrics related to click and conversion events are also included in the response.
+     * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
      */
-    revenueAnalytics?: boolean;
+    trackedSearchCount: number;
     /**
-     * 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 conversions from this search.
      */
-    endDate?: string;
+    conversionCount: number;
     /**
-     * Attribute by which to order the response items.  If the `clickAnalytics` parameter is false, only `searchCount` is available.
+     * Number of results (hits).
      */
-    orderBy?: OrderBy;
+    nbHits: number;
     /**
-     * Sorting direction of the results: ascending or descending.
+     * Revenue associated with this search, broken-down by currencies.
      */
-    direction?: Direction;
+    currencies: Record<string, CurrencyCode>;
     /**
-     * Number of items to return.
+     * 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.
      */
-    limit?: number;
+    addToCartRate: number | null;
     /**
-     * Position of the first item to return.
+     * Number of add-to-cart events from this search.
      */
-    offset?: number;
+    addToCartCount: 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/).
+     * 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.
      */
-    tags?: string;
+    purchaseRate: number | null;
+    /**
+     * Number of purchase events from this search.
+     */
+    purchaseCount: number;
 };
-/**
- * Properties for the `getUsersCount` method.
- */
-type GetUsersCountProps = {
+
+type TopSearchesResponseWithRevenueAnalytics = {
     /**
-     * Index name.
+     * Most popular searches, including their click and revenue metrics.
      */
-    index: string;
+    searches: TopSearchWithRevenueAnalytics[];
+};
+
+type GetTopSearchesResponse = TopSearchesResponse | TopSearchesResponseWithAnalytics | TopSearchesResponseWithRevenueAnalytics;
+
+type DailyUsers = {
     /**
-     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     * Date in the format YYYY-MM-DD.
      */
-    startDate?: string;
+    date: string;
     /**
-     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     * Number of unique users.
      */
-    endDate?: string;
+    count: number;
+};
+
+type GetUsersCountResponse = {
     /**
-     * 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 unique users.
      */
-    tags?: string;
+    count: number;
+    /**
+     * Daily number of unique users.
+     */
+    dates: DailyUsers[];
 };
 
-declare const apiClientVersion = "5.2.5";
+declare const apiClientVersion = "5.3.1";
 declare const REGIONS: readonly ["de", "us"];
 type Region = (typeof REGIONS)[number];
-
-/**
- * The client type.
- */
-type AnalyticsClient = ReturnType<typeof analyticsClient>;
-declare function analyticsClient(appId: string, apiKey: string, region?: Region, options?: ClientOptions): {
+declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }: CreateClientOptions & {
+    region?: Region;
+}): {
     transporter: _algolia_client_common.Transporter;
+    /**
+     * The `appId` currently in use.
+     */
     appId: string;
+    /**
+     * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
+     */
     clearCache(): Promise<void>;
+    /**
+     * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
+     */
     readonly _ua: string;
+    /**
+     * Adds a `segment` to the `x-algolia-agent` sent with every requests.
+     *
+     * @param segment - The algolia agent (user-agent) segment to add.
+     * @param version - The version of the agent.
+     */
     addAlgoliaAgent(segment: string, version?: string): void;
-    customDelete({ path, parameters }: CustomDeleteProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<Record<string, unknown>>;
-    customGet({ path, parameters }: CustomGetProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<Record<string, unknown>>;
-    customPost({ path, parameters, body }: CustomPostProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<Record<string, unknown>>;
-    customPut({ path, parameters, body }: CustomPutProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<Record<string, unknown>>;
-    getAddToCartRate({ index, startDate, endDate, tags }: GetAddToCartRateProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<GetAddToCartRateResponse>;
-    getAverageClickPosition({ index, startDate, endDate, tags }: GetAverageClickPositionProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<GetAverageClickPositionResponse>;
-    getClickPositions({ index, startDate, endDate, tags }: GetClickPositionsProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<GetClickPositionsResponse>;
-    getClickThroughRate({ index, startDate, endDate, tags }: GetClickThroughRateProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<GetClickThroughRateResponse>;
-    getConversionRate({ index, startDate, endDate, tags }: GetConversionRateProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<GetConversionRateResponse>;
-    getNoClickRate({ index, startDate, endDate, tags }: GetNoClickRateProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<GetNoClickRateResponse>;
-    getNoResultsRate({ index, startDate, endDate, tags }: GetNoResultsRateProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<GetNoResultsRateResponse>;
-    getPurchaseRate({ index, startDate, endDate, tags }: GetPurchaseRateProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<GetPurchaseRateResponse>;
-    getRevenue({ index, startDate, endDate, tags }: GetRevenueProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<GetRevenue>;
-    getSearchesCount({ index, startDate, endDate, tags }: GetSearchesCountProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<GetSearchesCountResponse>;
-    getSearchesNoClicks({ index, startDate, endDate, limit, offset, tags }: GetSearchesNoClicksProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<GetSearchesNoClicksResponse>;
-    getSearchesNoResults({ index, startDate, endDate, limit, offset, tags }: GetSearchesNoResultsProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<GetSearchesNoResultsResponse>;
-    getStatus({ index }: GetStatusProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<GetStatusResponse>;
-    getTopCountries({ index, startDate, endDate, limit, offset, tags }: GetTopCountriesProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<GetTopCountriesResponse>;
-    getTopFilterAttributes({ index, search, startDate, endDate, limit, offset, tags }: GetTopFilterAttributesProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<GetTopFilterAttributesResponse>;
-    getTopFilterForAttribute({ attribute, index, search, startDate, endDate, limit, offset, tags }: GetTopFilterForAttributeProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<GetTopFilterForAttributeResponse>;
-    getTopFiltersNoResults({ index, search, startDate, endDate, limit, offset, tags }: GetTopFiltersNoResultsProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<GetTopFiltersNoResultsResponse>;
-    getTopHits({ index, search, clickAnalytics, revenueAnalytics, startDate, endDate, limit, offset, tags }: GetTopHitsProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<GetTopHitsResponse>;
-    getTopSearches({ index, clickAnalytics, revenueAnalytics, startDate, endDate, orderBy, direction, limit, offset, tags, }: GetTopSearchesProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<GetTopSearchesResponse>;
-    getUsersCount({ index, startDate, endDate, tags }: GetUsersCountProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<GetUsersCountResponse>;
+    /**
+     * Helper method to switch the API key used to authenticate the requests.
+     *
+     * @param params - Method params.
+     * @param params.apiKey - The new API Key to use.
+     */
+    setClientApiKey({ apiKey }: {
+        apiKey: string;
+    }): 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.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    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.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    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.
+     * @param customPost.body - Parameters to send with the custom request.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    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.
+     * @param customPut.body - Parameters to send with the custom request.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    customPut({ path, parameters, body }: CustomPutProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
+    /**
+     * Retrieves the add-to-cart rate for all of your searches with at least one add-to-cart event, including a daily breakdown.  By default, the analyzed period includes the last eight days including the current day.
+     *
+     * Required API Key ACLs:
+     * - 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.
+     * @param getAddToCartRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
+     * @param getAddToCartRate.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    getAddToCartRate({ index, startDate, endDate, tags }: GetAddToCartRateProps, requestOptions?: RequestOptions): Promise<GetAddToCartRateResponse>;
+    /**
+     * Retrieves the average click position of your search results, including a daily breakdown.  The average click position is the average of all clicked search results\' positions. For example, if users only ever click on the first result for any search, the average click position is 1. By default, the analyzed period includes the last eight days including the current day.
+     *
+     * Required API Key ACLs:
+     * - 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.
+     * @param getAverageClickPosition.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
+     * @param getAverageClickPosition.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    getAverageClickPosition({ index, startDate, endDate, tags }: GetAverageClickPositionProps, requestOptions?: RequestOptions): Promise<GetAverageClickPositionResponse>;
+    /**
+     * Retrieves the positions in the search results and their associated number of clicks.  This lets you check how many clicks the first, second, or tenth search results receive.
+     *
+     * Required API Key ACLs:
+     * - 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.
+     * @param getClickPositions.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
+     * @param getClickPositions.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    getClickPositions({ index, startDate, endDate, tags }: GetClickPositionsProps, requestOptions?: RequestOptions): Promise<GetClickPositionsResponse>;
+    /**
+     * Retrieves the click-through rate for all of your searches with at least one click event, including a daily breakdown  By default, the analyzed period includes the last eight days including the current day.
+     *
+     * Required API Key ACLs:
+     * - 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.
+     * @param getClickThroughRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
+     * @param getClickThroughRate.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    getClickThroughRate({ index, startDate, endDate, tags }: GetClickThroughRateProps, requestOptions?: RequestOptions): Promise<GetClickThroughRateResponse>;
+    /**
+     * Retrieves the conversion rate for all of your searches with at least one conversion event, including a daily breakdown.  By default, the analyzed period includes the last eight days including the current day.
+     *
+     * Required API Key ACLs:
+     * - 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.
+     * @param getConversionRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
+     * @param getConversionRate.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    getConversionRate({ index, startDate, endDate, tags }: GetConversionRateProps, requestOptions?: RequestOptions): Promise<GetConversionRateResponse>;
+    /**
+     * Retrieves the fraction of searches that didn\'t lead to any click within a time range, including a daily breakdown.  By default, the analyzed period includes the last eight days including the current day.
+     *
+     * Required API Key ACLs:
+     * - 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.
+     * @param getNoClickRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
+     * @param getNoClickRate.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    getNoClickRate({ index, startDate, endDate, tags }: GetNoClickRateProps, requestOptions?: RequestOptions): Promise<GetNoClickRateResponse>;
+    /**
+     * Retrieves the fraction of searches that didn\'t return any results within a time range, including a daily breakdown.  By default, the analyzed period includes the last eight days including the current day.
+     *
+     * Required API Key ACLs:
+     * - 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.
+     * @param getNoResultsRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
+     * @param getNoResultsRate.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    getNoResultsRate({ index, startDate, endDate, tags }: GetNoResultsRateProps, requestOptions?: RequestOptions): Promise<GetNoResultsRateResponse>;
+    /**
+     * Retrieves the purchase rate for all of your searches with at least one purchase event, including a daily breakdown.  By default, the analyzed period includes the last eight days including the current day.
+     *
+     * Required API Key ACLs:
+     * - 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.
+     * @param getPurchaseRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
+     * @param getPurchaseRate.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    getPurchaseRate({ index, startDate, endDate, tags }: GetPurchaseRateProps, requestOptions?: RequestOptions): Promise<GetPurchaseRateResponse>;
+    /**
+     * Retrieves revenue-related metrics, such as the total revenue or the average order value.  To retrieve revenue-related metrics, sent purchase events. By default, the analyzed period includes the last eight days including the current day.
+     *
+     * Required API Key ACLs:
+     * - 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.
+     * @param getRevenue.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
+     * @param getRevenue.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    getRevenue({ index, startDate, endDate, tags }: GetRevenueProps, requestOptions?: RequestOptions): Promise<GetRevenue>;
+    /**
+     * 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.
+     *
+     * @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.
+     * @param getSearchesCount.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
+     * @param getSearchesCount.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    getSearchesCount({ index, startDate, endDate, tags }: GetSearchesCountProps, requestOptions?: RequestOptions): Promise<GetSearchesCountResponse>;
+    /**
+     * Retrieves the most popular searches that didn\'t lead to any clicks, from the 1,000 most frequent searches.
+     *
+     * Required API Key ACLs:
+     * - 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.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    getSearchesNoClicks({ index, startDate, endDate, limit, offset, tags }: GetSearchesNoClicksProps, requestOptions?: RequestOptions): Promise<GetSearchesNoClicksResponse>;
+    /**
+     * Retrieves the most popular searches that didn\'t return any results.
+     *
+     * Required API Key ACLs:
+     * - 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.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    getSearchesNoResults({ index, startDate, endDate, limit, offset, tags }: GetSearchesNoResultsProps, requestOptions?: RequestOptions): Promise<GetSearchesNoResultsResponse>;
+    /**
+     * Retrieves the time when the Analytics data for the specified index was last updated.  The Analytics data is updated every 5 minutes.
+     *
+     * Required API Key ACLs:
+     * - 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.
+     */
+    getStatus({ index }: GetStatusProps, requestOptions?: RequestOptions): Promise<GetStatusResponse>;
+    /**
+     * Retrieves the countries with the most searches to your index.
+     *
+     * Required API Key ACLs:
+     * - 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.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    getTopCountries({ index, startDate, endDate, limit, offset, tags }: GetTopCountriesProps, requestOptions?: RequestOptions): Promise<GetTopCountriesResponse>;
+    /**
+     * Retrieves the most frequently used filter attributes.  These are attributes of your records that you included in the `attributesForFaceting` setting.
+     *
+     * Required API Key ACLs:
+     * - 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.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    getTopFilterAttributes({ index, search, startDate, endDate, limit, offset, tags }: GetTopFilterAttributesProps, requestOptions?: RequestOptions): Promise<GetTopFilterAttributesResponse>;
+    /**
+     * Retrieves the most frequent filter (facet) values for a filter attribute.  These are attributes of your records that you included in the `attributesForFaceting` setting.
+     *
+     * Required API Key ACLs:
+     * - 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.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    getTopFilterForAttribute({ attribute, index, search, startDate, endDate, limit, offset, tags }: GetTopFilterForAttributeProps, requestOptions?: RequestOptions): Promise<GetTopFilterForAttributeResponse>;
+    /**
+     * Retrieves the most frequently used filters for a search that didn\'t return any results.  To get the most frequent searches without results, use the [Retrieve searches without results](#tag/search/operation/getSearchesNoResults) operation.
+     *
+     * Required API Key ACLs:
+     * - 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.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    getTopFiltersNoResults({ index, search, startDate, endDate, limit, offset, tags }: GetTopFiltersNoResultsProps, requestOptions?: RequestOptions): Promise<GetTopFiltersNoResultsResponse>;
+    /**
+     * Retrieves the object IDs of the most frequent search results.
+     *
+     * Required API Key ACLs:
+     * - analytics.
+     *
+     * @param getTopHits - The getTopHits object.
+     * @param getTopHits.index - Index name.
+     * @param getTopHits.search - Search query.
+     * @param getTopHits.clickAnalytics - Whether to include metrics related to click and conversion events in the response.
+     * @param getTopHits.revenueAnalytics - Whether to include revenue-related metrics in the response.  If true, metrics related to click and conversion events are also included in the response.
+     * @param getTopHits.startDate - Start date 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.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    getTopHits({ index, search, clickAnalytics, revenueAnalytics, startDate, endDate, limit, offset, tags }: GetTopHitsProps, requestOptions?: RequestOptions): Promise<GetTopHitsResponse>;
+    /**
+     * Returns the most popular search terms.
+     *
+     * Required API Key ACLs:
+     * - analytics.
+     *
+     * @param getTopSearches - The getTopSearches object.
+     * @param getTopSearches.index - Index name.
+     * @param getTopSearches.clickAnalytics - Whether to include metrics related to click and conversion events in the response.
+     * @param getTopSearches.revenueAnalytics - Whether to include revenue-related metrics in the response.  If true, metrics related to click and conversion events are also included in the response.
+     * @param getTopSearches.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+     * @param getTopSearches.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
+     * @param getTopSearches.orderBy - Attribute by which to order the response items.  If the `clickAnalytics` parameter is false, only `searchCount` is available.
+     * @param getTopSearches.direction - Sorting direction of the results: ascending or descending.
+     * @param getTopSearches.limit - Number of items to return.
+     * @param getTopSearches.offset - Position of the first item to return.
+     * @param getTopSearches.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    getTopSearches({ index, clickAnalytics, revenueAnalytics, startDate, endDate, orderBy, direction, limit, offset, tags, }: GetTopSearchesProps, requestOptions?: RequestOptions): Promise<GetTopSearchesResponse>;
+    /**
+     * Retrieves the number of unique users within a time range, including a daily breakdown.  Since this endpoint returns the number of unique users, the sum of the daily values might be different from the total number.  By default, Algolia distinguishes search users by their IP address, _unless_ you include a pseudonymous user identifier in your search requests with the `userToken` API parameter or `x-algolia-usertoken` request header. By default, the analyzed period includes the last eight days including the current day.
+     *
+     * Required API Key ACLs:
+     * - 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.
+     * @param getUsersCount.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
+     * @param getUsersCount.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    getUsersCount({ index, startDate, endDate, tags }: GetUsersCountProps, requestOptions?: RequestOptions): Promise<GetUsersCountResponse>;
+};
+
+/**
+ * Error.
+ */
+type ErrorBase = Record<string, any> & {
+    message?: string;
 };
 
+type AnalyticsClient = ReturnType<typeof createAnalyticsClient>;
+
+declare function analyticsClient(appId: string, apiKey: string, region?: Region, options?: ClientOptions): AnalyticsClient;
+
 export { type AnalyticsClient, type ClickPosition, type CurrencyCode, type CustomDeleteProps, type CustomGetProps, type CustomPostProps, type CustomPutProps, type DailyAddToCartRates, type DailyAverageClicks, type DailyClickThroughRates, type DailyConversionRates, type DailyNoClickRates, type DailyNoResultsRates, type DailyPurchaseRates, type DailyRevenue, type DailySearches, type DailySearchesNoClicks, type DailySearchesNoResults, type DailyUsers, type Direction, type ErrorBase, type GetAddToCartRateProps, type GetAddToCartRateResponse, type GetAverageClickPositionProps, type GetAverageClickPositionResponse, type GetClickPositionsProps, type GetClickPositionsResponse, type GetClickThroughRateProps, type GetClickThroughRateResponse, type GetConversionRateProps, type GetConversionRateResponse, type GetNoClickRateProps, type GetNoClickRateResponse, type GetNoResultsRateProps, type GetNoResultsRateResponse, type GetPurchaseRateProps, type GetPurchaseRateResponse, type GetRevenue, type GetRevenueProps, type GetSearchesCountProps, type GetSearchesCountResponse, type GetSearchesNoClicksProps, type GetSearchesNoClicksResponse, type GetSearchesNoResultsProps, type GetSearchesNoResultsResponse, type GetStatusProps, type GetStatusResponse, type GetTopCountriesProps, type GetTopCountriesResponse, type GetTopFilterAttribute, type GetTopFilterAttributesProps, type GetTopFilterAttributesResponse, type GetTopFilterForAttribute, type GetTopFilterForAttributeProps, type GetTopFilterForAttributeResponse, type GetTopFiltersNoResultsProps, type GetTopFiltersNoResultsResponse, type GetTopFiltersNoResultsValue, type GetTopFiltersNoResultsValues, type GetTopHitsProps, type GetTopHitsResponse, type GetTopSearchesProps, type GetTopSearchesResponse, type GetUsersCountProps, type GetUsersCountResponse, type Operator, type OrderBy, type Region, type TopCountry, type TopHit, type TopHitWithAnalytics, type TopHitWithRevenueAnalytics, type TopHitsResponse, type TopHitsResponseWithAnalytics, type TopHitsResponseWithRevenueAnalytics, type TopSearch, type TopSearchWithAnalytics, type TopSearchWithRevenueAnalytics, type TopSearchesResponse, type TopSearchesResponseWithAnalytics, type TopSearchesResponseWithRevenueAnalytics, analyticsClient, apiClientVersion };