@algolia/client-analytics 5.2.4 → 5.2.5

package/dist/node.d.ts

@@ -0,0 +1,1399 @@
+import * as _algolia_client_common from '@algolia/client-common';
+import { ClientOptions } from '@algolia/client-common';
+
+/**
+ * Click position.
+ */
+type ClickPosition = {
+    /**
+     * Range of positions in the search results, using the pattern `[start,end]`.  For positions 11 and up, click events are summed over the specified range. `-1` indicates the end of the list of search results.
+     */
+    position?: number[];
+    /**
+     * Number of times this search has been clicked at that position.
+     */
+    clickCount?: number;
+};
+
+/**
+ * Currency code.
+ */
+type CurrencyCode = {
+    /**
+     * Currency code.
+     */
+    currency?: string;
+    /**
+     * Revenue associated with this search in this currency.
+     */
+    revenue?: number;
+};
+
+type DailyAddToCartRates = {
+    /**
+     * Add-to-cart rate, calculated as number of tracked searches with at least one add-to-cart event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
+     */
+    rate: number | null;
+    /**
+     * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
+     */
+    trackedSearchCount: number;
+    /**
+     * Number of add-to-cart events from this search.
+     */
+    addToCartCount: number;
+    /**
+     * Date in the format YYYY-MM-DD.
+     */
+    date: string;
+};
+
+type DailyAverageClicks = {
+    /**
+     * Average position of a clicked search result in the list of search results. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
+     */
+    average: number | null;
+    /**
+     * Number of clicks associated with this search.
+     */
+    clickCount: number;
+    /**
+     * Date in the format YYYY-MM-DD.
+     */
+    date: string;
+};
+
+type DailyClickThroughRates = {
+    /**
+     * Click-through rate, calculated as number of tracked searches with at least one click event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
+     */
+    rate: number | null;
+    /**
+     * Number of clicks associated with this search.
+     */
+    clickCount: number;
+    /**
+     * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
+     */
+    trackedSearchCount: number;
+    /**
+     * Date in the format YYYY-MM-DD.
+     */
+    date: string;
+};
+
+type DailyConversionRates = {
+    /**
+     * Conversion rate, calculated as number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
+     */
+    rate: number | null;
+    /**
+     * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
+     */
+    trackedSearchCount: number;
+    /**
+     * Number of conversions from this search.
+     */
+    conversionCount: number;
+    /**
+     * Date in the format YYYY-MM-DD.
+     */
+    date: string;
+};
+
+type DailyNoClickRates = {
+    /**
+     * No click rate, calculated as number of tracked searches without any click divided by the number of tracked searches.
+     */
+    rate: number;
+    /**
+     * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
+     */
+    count: number;
+    /**
+     * Number of times this search was returned as a result without any click.
+     */
+    noClickCount: number;
+    /**
+     * Date in the format YYYY-MM-DD.
+     */
+    date: string;
+};
+
+type DailyNoResultsRates = {
+    /**
+     * Date in the format YYYY-MM-DD.
+     */
+    date: string;
+    /**
+     * Number of searches without any results.
+     */
+    noResultCount: number;
+    /**
+     * Number of searches.
+     */
+    count: number;
+    /**
+     * No results rate, calculated as number of searches with zero results divided by the total number of searches.
+     */
+    rate: number;
+};
+
+type DailyPurchaseRates = {
+    /**
+     * Purchase rate, calculated as number of tracked searches with at least one purchase event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
+     */
+    rate: number | null;
+    /**
+     * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
+     */
+    trackedSearchCount: number;
+    /**
+     * Number of purchase events from this search.
+     */
+    purchaseCount: number;
+    /**
+     * Date in the format YYYY-MM-DD.
+     */
+    date: string;
+};
+
+type DailyRevenue = {
+    /**
+     * Revenue associated with this search, broken-down by currencies.
+     */
+    currencies: Record<string, CurrencyCode>;
+    /**
+     * Date in the format YYYY-MM-DD.
+     */
+    date: string;
+};
+
+type DailySearches = {
+    /**
+     * Date in the format YYYY-MM-DD.
+     */
+    date: string;
+    /**
+     * Number of occurrences.
+     */
+    count: number;
+};
+
+type DailySearchesNoClicks = {
+    /**
+     * Search query.
+     */
+    search: string;
+    /**
+     * Number of tracked searches.
+     */
+    count: number;
+    /**
+     * Number of results (hits).
+     */
+    nbHits: number;
+};
+
+type DailySearchesNoResults = {
+    /**
+     * Search query.
+     */
+    search: string;
+    /**
+     * Number of occurrences.
+     */
+    count: number;
+    /**
+     * Number of searches for this term with applied filters.
+     */
+    withFilterCount: number;
+};
+
+type DailyUsers = {
+    /**
+     * Date in the format YYYY-MM-DD.
+     */
+    date: string;
+    /**
+     * Number of unique users.
+     */
+    count: number;
+};
+
+type Direction = 'asc' | 'desc';
+
+/**
+ * Error.
+ */
+type ErrorBase = Record<string, any> & {
+    message?: string;
+};
+
+type GetAddToCartRateResponse = {
+    /**
+     * Add-to-cart rate, calculated as number of tracked searches with at least one add-to-cart event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
+     */
+    rate: number | null;
+    /**
+     * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
+     */
+    trackedSearchCount: number;
+    /**
+     * Number of add-to-cart events from this search.
+     */
+    addToCartCount: number;
+    /**
+     * Daily add-to-cart rates.
+     */
+    dates: DailyAddToCartRates[];
+};
+
+type GetAverageClickPositionResponse = {
+    /**
+     * Average position of a clicked search result in the list of search results. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
+     */
+    average: number | null;
+    /**
+     * Number of clicks associated with this search.
+     */
+    clickCount: number;
+    /**
+     * Daily average click positions.
+     */
+    dates: DailyAverageClicks[];
+};
+
+type GetClickPositionsResponse = {
+    /**
+     * List of positions in the search results and clicks associated with this search.
+     */
+    positions: ClickPosition[];
+};
+
+type GetClickThroughRateResponse = {
+    /**
+     * Click-through rate, calculated as number of tracked searches with at least one click event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
+     */
+    rate: number | null;
+    /**
+     * Number of clicks associated with this search.
+     */
+    clickCount: number;
+    /**
+     * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
+     */
+    trackedSearchCount: number;
+    /**
+     * Daily click-through rates.
+     */
+    dates: DailyClickThroughRates[];
+};
+
+type GetConversionRateResponse = {
+    /**
+     * Conversion rate, calculated as number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
+     */
+    rate: number | null;
+    /**
+     * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
+     */
+    trackedSearchCount: number;
+    /**
+     * Number of conversions from this search.
+     */
+    conversionCount: number;
+    /**
+     * Daily conversion rates.
+     */
+    dates: DailyConversionRates[];
+};
+
+type GetNoClickRateResponse = {
+    /**
+     * No click rate, calculated as number of tracked searches without any click divided by the number of tracked searches.
+     */
+    rate: number;
+    /**
+     * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
+     */
+    count: number;
+    /**
+     * Number of times this search was returned as a result without any click.
+     */
+    noClickCount: number;
+    /**
+     * Daily no click rates.
+     */
+    dates: DailyNoClickRates[];
+};
+
+type GetNoResultsRateResponse = {
+    /**
+     * No results rate, calculated as number of searches with zero results divided by the total number of searches.
+     */
+    rate: number;
+    /**
+     * Number of searches.
+     */
+    count: number;
+    /**
+     * Number of searches without any results.
+     */
+    noResultCount: number;
+    /**
+     * Daily no results rates.
+     */
+    dates: DailyNoResultsRates[];
+};
+
+type GetPurchaseRateResponse = {
+    /**
+     * Purchase rate, calculated as number of tracked searches with at least one purchase event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
+     */
+    rate: number | null;
+    /**
+     * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
+     */
+    trackedSearchCount: number;
+    /**
+     * Number of purchase events from this search.
+     */
+    purchaseCount: number;
+    /**
+     * Daily purchase rates.
+     */
+    dates: DailyPurchaseRates[];
+};
+
+type GetRevenue = {
+    /**
+     * Revenue associated with this search, broken-down by currencies.
+     */
+    currencies: Record<string, CurrencyCode>;
+    /**
+     * Daily revenue.
+     */
+    dates: DailyRevenue[];
+};
+
+type GetSearchesCountResponse = {
+    /**
+     * Number of occurrences.
+     */
+    count: number;
+    /**
+     * Daily number of searches.
+     */
+    dates: DailySearches[];
+};
+
+type GetSearchesNoClicksResponse = {
+    /**
+     * Searches without any clicks.
+     */
+    searches: DailySearchesNoClicks[];
+};
+
+type GetSearchesNoResultsResponse = {
+    /**
+     * Searches without results.
+     */
+    searches: DailySearchesNoResults[];
+};
+
+type GetStatusResponse = {
+    /**
+     * Date and time when the object was updated, in RFC 3339 format.
+     */
+    updatedAt: string | null;
+};
+
+type TopCountry = {
+    /**
+     * Country code.
+     */
+    country: string;
+    /**
+     * Number of occurrences.
+     */
+    count: number;
+};
+
+type GetTopCountriesResponse = {
+    /**
+     * Countries and number of searches.
+     */
+    countries: TopCountry[];
+};
+
+type GetTopFilterAttribute = {
+    /**
+     * Attribute name.
+     */
+    attribute: string;
+    /**
+     * Number of occurrences.
+     */
+    count: number;
+};
+
+type GetTopFilterAttributesResponse = {
+    /**
+     * Most frequent filters.
+     */
+    attributes: GetTopFilterAttribute[];
+};
+
+/**
+ * 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 Operator = ':' | '!=' | '<' | '<=' | '=' | '>' | '>=';
+
+type GetTopFilterForAttribute = {
+    /**
+     * Attribute name.
+     */
+    attribute: string;
+    operator: Operator;
+    /**
+     * Attribute value.
+     */
+    value: string;
+    /**
+     * Number of occurrences.
+     */
+    count: number;
+};
+
+type GetTopFilterForAttributeResponse = {
+    /**
+     * Filter values for an attribute.
+     */
+    values: GetTopFilterForAttribute[];
+};
+
+type GetTopFiltersNoResultsValue = {
+    /**
+     * Attribute name.
+     */
+    attribute: string;
+    operator: Operator;
+    /**
+     * Attribute value.
+     */
+    value: string;
+};
+
+type GetTopFiltersNoResultsValues = {
+    /**
+     * Number of occurrences.
+     */
+    count: number;
+    /**
+     * Filters with no results.
+     */
+    values: GetTopFiltersNoResultsValue[];
+};
+
+type GetTopFiltersNoResultsResponse = {
+    /**
+     * Filters for searches without any results. If null, the search term specified with the `search` parameter is not a search without results, or the `search` parameter is absent from the request.
+     */
+    values: GetTopFiltersNoResultsValues[] | null;
+};
+
+type TopHit = {
+    /**
+     * Object ID of a record that\'s returned as a search result.
+     */
+    hit: string;
+    /**
+     * Number of occurrences.
+     */
+    count: number;
+};
+
+type TopHitsResponse = {
+    /**
+     * Most frequent search results.
+     */
+    hits: TopHit[];
+};
+
+type TopHitWithAnalytics = {
+    /**
+     * Object ID of a record that\'s returned as a search result.
+     */
+    hit: string;
+    /**
+     * Number of occurrences.
+     */
+    count: number;
+    /**
+     * Click-through rate, calculated as number of tracked searches with at least one click event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
+     */
+    clickThroughRate: number | null;
+    /**
+     * Conversion rate, calculated as number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
+     */
+    conversionRate: number | null;
+    /**
+     * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
+     */
+    trackedHitCount: number;
+    /**
+     * Number of clicks associated with this search.
+     */
+    clickCount: number;
+    /**
+     * Number of conversions from this search.
+     */
+    conversionCount: number;
+};
+
+type TopHitsResponseWithAnalytics = {
+    /**
+     * Most frequent search results with click and conversion metrics.
+     */
+    hits: TopHitWithAnalytics[];
+};
+
+type TopHitWithRevenueAnalytics = {
+    /**
+     * Object ID of a record that\'s returned as a search result.
+     */
+    hit: string;
+    /**
+     * Number of occurrences.
+     */
+    count: number;
+    /**
+     * Click-through rate, calculated as number of tracked searches with at least one click event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
+     */
+    clickThroughRate: number | null;
+    /**
+     * Conversion rate, calculated as number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
+     */
+    conversionRate: number | null;
+    /**
+     * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
+     */
+    trackedHitCount: number;
+    /**
+     * Number of clicks associated with this search.
+     */
+    clickCount: number;
+    /**
+     * Number of conversions from this search.
+     */
+    conversionCount: number;
+    /**
+     * Add-to-cart rate, calculated as number of tracked searches with at least one add-to-cart event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
+     */
+    addToCartRate: number | null;
+    /**
+     * Number of add-to-cart events from this search.
+     */
+    addToCartCount: number;
+    /**
+     * Purchase rate, calculated as number of tracked searches with at least one purchase event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
+     */
+    purchaseRate: number | null;
+    /**
+     * Number of purchase events from this search.
+     */
+    purchaseCount: number;
+    /**
+     * Revenue associated with this search, broken-down by currencies.
+     */
+    currencies: Record<string, CurrencyCode>;
+};
+
+type TopHitsResponseWithRevenueAnalytics = {
+    /**
+     * Most frequent search results with click, conversion, and revenue metrics.
+     */
+    hits: TopHitWithRevenueAnalytics[];
+};
+
+type GetTopHitsResponse = TopHitsResponse | TopHitsResponseWithAnalytics | TopHitsResponseWithRevenueAnalytics;
+
+type TopSearch = {
+    /**
+     * Search query.
+     */
+    search: string;
+    /**
+     * Number of searches.
+     */
+    count: number;
+    /**
+     * Number of results (hits).
+     */
+    nbHits: number;
+};
+
+type TopSearchesResponse = {
+    /**
+     * Most popular searches and their number of search results (hits).
+     */
+    searches: TopSearch[];
+};
+
+type TopSearchWithAnalytics = {
+    /**
+     * Search query.
+     */
+    search: string;
+    /**
+     * Number of searches.
+     */
+    count: number;
+    /**
+     * Click-through rate, calculated as number of tracked searches with at least one click event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
+     */
+    clickThroughRate: number | null;
+    /**
+     * Average position of a clicked search result in the list of search results. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
+     */
+    averageClickPosition: number | null;
+    /**
+     * List of positions in the search results and clicks associated with this search.
+     */
+    clickPositions: ClickPosition[];
+    /**
+     * Conversion rate, calculated as number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
+     */
+    conversionRate: number | null;
+    /**
+     * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
+     */
+    trackedSearchCount: number;
+    /**
+     * Number of clicks associated with this search.
+     */
+    clickCount: number;
+    /**
+     * Number of conversions from this search.
+     */
+    conversionCount: number;
+    /**
+     * Number of results (hits).
+     */
+    nbHits: number;
+};
+
+type TopSearchesResponseWithAnalytics = {
+    /**
+     * Most popular searches and their associated click and conversion metrics.
+     */
+    searches: TopSearchWithAnalytics[];
+};
+
+type TopSearchWithRevenueAnalytics = {
+    /**
+     * Search query.
+     */
+    search: string;
+    /**
+     * Number of searches.
+     */
+    count: number;
+    /**
+     * Click-through rate, calculated as number of tracked searches with at least one click event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
+     */
+    clickThroughRate: number | null;
+    /**
+     * Average position of a clicked search result in the list of search results. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
+     */
+    averageClickPosition: number | null;
+    /**
+     * List of positions in the search results and clicks associated with this search.
+     */
+    clickPositions: ClickPosition[];
+    /**
+     * Conversion rate, calculated as number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
+     */
+    conversionRate: number | null;
+    /**
+     * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
+     */
+    trackedSearchCount: number;
+    /**
+     * Number of clicks associated with this search.
+     */
+    clickCount: number;
+    /**
+     * Number of conversions from this search.
+     */
+    conversionCount: number;
+    /**
+     * Number of results (hits).
+     */
+    nbHits: number;
+    /**
+     * Revenue associated with this search, broken-down by currencies.
+     */
+    currencies: Record<string, CurrencyCode>;
+    /**
+     * Add-to-cart rate, calculated as number of tracked searches with at least one add-to-cart event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
+     */
+    addToCartRate: number | null;
+    /**
+     * Number of add-to-cart events from this search.
+     */
+    addToCartCount: number;
+    /**
+     * Purchase rate, calculated as number of tracked searches with at least one purchase event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
+     */
+    purchaseRate: number | null;
+    /**
+     * Number of purchase events from this search.
+     */
+    purchaseCount: number;
+};
+
+type TopSearchesResponseWithRevenueAnalytics = {
+    /**
+     * Most popular searches, including their click and revenue metrics.
+     */
+    searches: TopSearchWithRevenueAnalytics[];
+};
+
+type GetTopSearchesResponse = TopSearchesResponse | TopSearchesResponseWithAnalytics | TopSearchesResponseWithRevenueAnalytics;
+
+type GetUsersCountResponse = {
+    /**
+     * Number of unique users.
+     */
+    count: number;
+    /**
+     * Daily number of unique users.
+     */
+    dates: DailyUsers[];
+};
+
+/**
+ * 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 = {
+    /**
+     * Path of the endpoint, anything after \"/1\" must be specified.
+     */
+    path: string;
+    /**
+     * Query parameters to apply to the current query.
+     */
+    parameters?: Record<string, any>;
+};
+/**
+ * Properties for the `customGet` method.
+ */
+type CustomGetProps = {
+    /**
+     * Path of the endpoint, anything after \"/1\" must be specified.
+     */
+    path: string;
+    /**
+     * Query parameters to apply to the current query.
+     */
+    parameters?: Record<string, any>;
+};
+/**
+ * Properties for the `customPost` method.
+ */
+type CustomPostProps = {
+    /**
+     * Path of the endpoint, anything after \"/1\" must be specified.
+     */
+    path: string;
+    /**
+     * Query parameters to apply to the current query.
+     */
+    parameters?: Record<string, any>;
+    /**
+     * Parameters to send with the custom request.
+     */
+    body?: Record<string, unknown>;
+};
+/**
+ * Properties for the `customPut` method.
+ */
+type CustomPutProps = {
+    /**
+     * Path of the endpoint, anything after \"/1\" must be specified.
+     */
+    path: string;
+    /**
+     * Query parameters to apply to the current query.
+     */
+    parameters?: Record<string, any>;
+    /**
+     * Parameters to send with the custom request.
+     */
+    body?: Record<string, unknown>;
+};
+/**
+ * Properties for the `getAddToCartRate` method.
+ */
+type GetAddToCartRateProps = {
+    /**
+     * Index name.
+     */
+    index: string;
+    /**
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    startDate?: string;
+    /**
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    endDate?: string;
+    /**
+     * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+     */
+    tags?: string;
+};
+/**
+ * Properties for the `getAverageClickPosition` method.
+ */
+type GetAverageClickPositionProps = {
+    /**
+     * Index name.
+     */
+    index: string;
+    /**
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    startDate?: string;
+    /**
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    endDate?: string;
+    /**
+     * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+     */
+    tags?: string;
+};
+/**
+ * Properties for the `getClickPositions` method.
+ */
+type GetClickPositionsProps = {
+    /**
+     * Index name.
+     */
+    index: string;
+    /**
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    startDate?: string;
+    /**
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    endDate?: string;
+    /**
+     * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+     */
+    tags?: string;
+};
+/**
+ * Properties for the `getClickThroughRate` method.
+ */
+type GetClickThroughRateProps = {
+    /**
+     * Index name.
+     */
+    index: string;
+    /**
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    startDate?: string;
+    /**
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    endDate?: string;
+    /**
+     * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+     */
+    tags?: 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;
+    /**
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    endDate?: string;
+    /**
+     * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+     */
+    tags?: string;
+};
+/**
+ * Properties for the `getNoClickRate` method.
+ */
+type GetNoClickRateProps = {
+    /**
+     * Index name.
+     */
+    index: string;
+    /**
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    startDate?: string;
+    /**
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    endDate?: string;
+    /**
+     * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+     */
+    tags?: string;
+};
+/**
+ * Properties for the `getNoResultsRate` method.
+ */
+type GetNoResultsRateProps = {
+    /**
+     * Index name.
+     */
+    index: string;
+    /**
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    startDate?: string;
+    /**
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    endDate?: string;
+    /**
+     * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+     */
+    tags?: string;
+};
+/**
+ * Properties for the `getPurchaseRate` method.
+ */
+type GetPurchaseRateProps = {
+    /**
+     * Index name.
+     */
+    index: string;
+    /**
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    startDate?: string;
+    /**
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    endDate?: string;
+    /**
+     * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+     */
+    tags?: string;
+};
+/**
+ * Properties for the `getRevenue` method.
+ */
+type GetRevenueProps = {
+    /**
+     * Index name.
+     */
+    index: string;
+    /**
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    startDate?: string;
+    /**
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    endDate?: string;
+    /**
+     * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+     */
+    tags?: string;
+};
+/**
+ * Properties for the `getSearchesCount` method.
+ */
+type GetSearchesCountProps = {
+    /**
+     * Index name.
+     */
+    index: string;
+    /**
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    startDate?: string;
+    /**
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    endDate?: string;
+    /**
+     * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+     */
+    tags?: string;
+};
+/**
+ * Properties for the `getSearchesNoClicks` method.
+ */
+type GetSearchesNoClicksProps = {
+    /**
+     * Index name.
+     */
+    index: string;
+    /**
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    startDate?: string;
+    /**
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    endDate?: string;
+    /**
+     * Number of items to return.
+     */
+    limit?: number;
+    /**
+     * Position of the first item to return.
+     */
+    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;
+};
+/**
+ * Properties for the `getSearchesNoResults` method.
+ */
+type GetSearchesNoResultsProps = {
+    /**
+     * Index name.
+     */
+    index: string;
+    /**
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    startDate?: string;
+    /**
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    endDate?: string;
+    /**
+     * Number of items to return.
+     */
+    limit?: number;
+    /**
+     * Position of the first item to return.
+     */
+    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;
+};
+/**
+ * Properties for the `getStatus` method.
+ */
+type GetStatusProps = {
+    /**
+     * Index name.
+     */
+    index: string;
+};
+/**
+ * Properties for the `getTopCountries` method.
+ */
+type GetTopCountriesProps = {
+    /**
+     * Index name.
+     */
+    index: string;
+    /**
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    startDate?: string;
+    /**
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    endDate?: string;
+    /**
+     * Number of items to return.
+     */
+    limit?: number;
+    /**
+     * Position of the first item to return.
+     */
+    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;
+};
+/**
+ * Properties for the `getTopFilterAttributes` method.
+ */
+type GetTopFilterAttributesProps = {
+    /**
+     * Index name.
+     */
+    index: string;
+    /**
+     * Search query.
+     */
+    search?: string;
+    /**
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    startDate?: string;
+    /**
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    endDate?: string;
+    /**
+     * Number of items to return.
+     */
+    limit?: number;
+    /**
+     * Position of the first item to return.
+     */
+    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;
+};
+/**
+ * Properties for the `getTopFilterForAttribute` method.
+ */
+type GetTopFilterForAttributeProps = {
+    /**
+     * Attribute name.
+     */
+    attribute: string;
+    /**
+     * Index name.
+     */
+    index: string;
+    /**
+     * Search query.
+     */
+    search?: string;
+    /**
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    startDate?: string;
+    /**
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    endDate?: string;
+    /**
+     * Number of items to return.
+     */
+    limit?: number;
+    /**
+     * Position of the first item to return.
+     */
+    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;
+};
+/**
+ * Properties for the `getTopFiltersNoResults` method.
+ */
+type GetTopFiltersNoResultsProps = {
+    /**
+     * Index name.
+     */
+    index: string;
+    /**
+     * Search query.
+     */
+    search?: string;
+    /**
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    startDate?: string;
+    /**
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    endDate?: string;
+    /**
+     * Number of items to return.
+     */
+    limit?: number;
+    /**
+     * Position of the first item to return.
+     */
+    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;
+};
+/**
+ * Properties for the `getTopHits` method.
+ */
+type GetTopHitsProps = {
+    /**
+     * Index name.
+     */
+    index: string;
+    /**
+     * Search query.
+     */
+    search?: string;
+    /**
+     * Whether to include metrics related to click and conversion events in the response.
+     */
+    clickAnalytics?: boolean;
+    /**
+     * Whether to include revenue-related metrics in the response.  If true, metrics related to click and conversion events are also included in the response.
+     */
+    revenueAnalytics?: boolean;
+    /**
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    startDate?: string;
+    /**
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    endDate?: string;
+    /**
+     * Number of items to return.
+     */
+    limit?: number;
+    /**
+     * Position of the first item to return.
+     */
+    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;
+};
+/**
+ * Properties for the `getTopSearches` method.
+ */
+type GetTopSearchesProps = {
+    /**
+     * Index name.
+     */
+    index: string;
+    /**
+     * Whether to include metrics related to click and conversion events in the response.
+     */
+    clickAnalytics?: boolean;
+    /**
+     * Whether to include revenue-related metrics in the response.  If true, metrics related to click and conversion events are also included in the response.
+     */
+    revenueAnalytics?: boolean;
+    /**
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    startDate?: string;
+    /**
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    endDate?: string;
+    /**
+     * Attribute by which to order the response items.  If the `clickAnalytics` parameter is false, only `searchCount` is available.
+     */
+    orderBy?: OrderBy;
+    /**
+     * Sorting direction of the results: ascending or descending.
+     */
+    direction?: Direction;
+    /**
+     * Number of items to return.
+     */
+    limit?: number;
+    /**
+     * Position of the first item to return.
+     */
+    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;
+};
+/**
+ * Properties for the `getUsersCount` method.
+ */
+type GetUsersCountProps = {
+    /**
+     * Index name.
+     */
+    index: string;
+    /**
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    startDate?: string;
+    /**
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    endDate?: string;
+    /**
+     * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+     */
+    tags?: string;
+};
+
+declare const apiClientVersion = "5.2.5";
+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): {
+    transporter: _algolia_client_common.Transporter;
+    appId: string;
+    clearCache(): Promise<void>;
+    _ua: string;
+    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>;
+};
+
+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 };