From 2d621ef70464c9ba3022f92580e14b651f7b1b5e Mon Sep 17 00:00:00 2001 From: algolia-bot Date: Thu, 16 Jan 2025 10:58:59 +0000 Subject: [PATCH] fix(specs): extend Analytics descriptions (generated) https://github.com/algolia/api-clients-automation/pull/4360 Co-authored-by: algolia-bot Co-authored-by: gazconroy Co-authored-by: Gary Conroy Co-authored-by: Kai Welke --- .../model/clientMethodProps.ts | 4 +- .../model/dailyAddToCartRates.ts | 2 +- .../model/dailyClickThroughRates.ts | 2 +- .../model/dailyConversionRates.ts | 2 +- .../model/dailyNoClickRates.ts | 2 +- .../model/dailyNoResultsRates.ts | 2 +- .../model/dailyPurchaseRates.ts | 2 +- .../client-analytics/model/dailyRevenue.ts | 2 +- .../model/getAddToCartRateResponse.ts | 2 +- .../model/getClickThroughRateResponse.ts | 2 +- .../model/getConversionRateResponse.ts | 2 +- .../model/getNoClickRateResponse.ts | 2 +- .../model/getNoResultsRateResponse.ts | 2 +- .../model/getPurchaseRateResponse.ts | 2 +- packages/client-analytics/model/getRevenue.ts | 2 +- .../model/getTopFiltersNoResultsResponse.ts | 2 +- packages/client-analytics/model/topHit.ts | 2 +- .../model/topHitWithAnalytics.ts | 6 +-- .../model/topHitWithRevenueAnalytics.ts | 12 +++--- .../model/topSearchWithAnalytics.ts | 4 +- .../model/topSearchWithRevenueAnalytics.ts | 10 ++--- .../client-analytics/src/analyticsClient.ts | 42 +++++++++---------- 22 files changed, 55 insertions(+), 55 deletions(-) diff --git a/packages/client-analytics/model/clientMethodProps.ts b/packages/client-analytics/model/clientMethodProps.ts index 30bd061f0..512cc4fa5 100644 --- a/packages/client-analytics/model/clientMethodProps.ts +++ b/packages/client-analytics/model/clientMethodProps.ts @@ -511,7 +511,7 @@ export type GetTopHitsProps = { */ clickAnalytics?: boolean; /** - * Whether to include revenue-related metrics in the response. If true, metrics related to click and conversion events are also included in the response. + * Whether to include metrics related to revenue events in the response. */ revenueAnalytics?: boolean; /** @@ -549,7 +549,7 @@ export type GetTopSearchesProps = { */ clickAnalytics?: boolean; /** - * Whether to include revenue-related metrics in the response. If true, metrics related to click and conversion events are also included in the response. + * Whether to include metrics related to revenue events in the response. */ revenueAnalytics?: boolean; /** diff --git a/packages/client-analytics/model/dailyAddToCartRates.ts b/packages/client-analytics/model/dailyAddToCartRates.ts index 8a3e5c591..9b4d29066 100644 --- a/packages/client-analytics/model/dailyAddToCartRates.ts +++ b/packages/client-analytics/model/dailyAddToCartRates.ts @@ -2,7 +2,7 @@ export type DailyAddToCartRates = { /** - * Add-to-cart rate, calculated as number of tracked searches with at least one add-to-cart event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true. + * Add-to-cart rate: calculated as the number of tracked searches with at least one add-to-cart event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true. */ rate: number | null; diff --git a/packages/client-analytics/model/dailyClickThroughRates.ts b/packages/client-analytics/model/dailyClickThroughRates.ts index e11b581b3..bec5f12ac 100644 --- a/packages/client-analytics/model/dailyClickThroughRates.ts +++ b/packages/client-analytics/model/dailyClickThroughRates.ts @@ -2,7 +2,7 @@ export type DailyClickThroughRates = { /** - * Click-through rate, calculated as number of tracked searches with at least one click event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true. + * Click-through rate: calculated as the number of tracked searches with at least one click event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true. */ rate: number | null; diff --git a/packages/client-analytics/model/dailyConversionRates.ts b/packages/client-analytics/model/dailyConversionRates.ts index 286dfae7f..d1599a4ce 100644 --- a/packages/client-analytics/model/dailyConversionRates.ts +++ b/packages/client-analytics/model/dailyConversionRates.ts @@ -2,7 +2,7 @@ export type DailyConversionRates = { /** - * Conversion rate, calculated as number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true. + * Conversion rate: calculated as the number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true. */ rate: number | null; diff --git a/packages/client-analytics/model/dailyNoClickRates.ts b/packages/client-analytics/model/dailyNoClickRates.ts index 4cb418a70..74addb9e1 100644 --- a/packages/client-analytics/model/dailyNoClickRates.ts +++ b/packages/client-analytics/model/dailyNoClickRates.ts @@ -2,7 +2,7 @@ export type DailyNoClickRates = { /** - * No click rate, calculated as number of tracked searches without any click divided by the number of tracked searches. + * No click rate: calculated as the number of tracked searches without clicks divided by the number of tracked searches. */ rate: number; diff --git a/packages/client-analytics/model/dailyNoResultsRates.ts b/packages/client-analytics/model/dailyNoResultsRates.ts index d9c33c23f..fb9148285 100644 --- a/packages/client-analytics/model/dailyNoResultsRates.ts +++ b/packages/client-analytics/model/dailyNoResultsRates.ts @@ -17,7 +17,7 @@ export type DailyNoResultsRates = { count: number; /** - * No results rate, calculated as number of searches with zero results divided by the total number of searches. + * No results rate: calculated as the number of searches with zero results divided by the total number of searches. */ rate: number; }; diff --git a/packages/client-analytics/model/dailyPurchaseRates.ts b/packages/client-analytics/model/dailyPurchaseRates.ts index d360dd9ca..1c54a3798 100644 --- a/packages/client-analytics/model/dailyPurchaseRates.ts +++ b/packages/client-analytics/model/dailyPurchaseRates.ts @@ -2,7 +2,7 @@ export type DailyPurchaseRates = { /** - * Purchase rate, calculated as number of tracked searches with at least one purchase event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true. + * Purchase rate: calculated as the number of tracked searches with at least one purchase event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true. */ rate: number | null; diff --git a/packages/client-analytics/model/dailyRevenue.ts b/packages/client-analytics/model/dailyRevenue.ts index 46b3581d9..cfdc08a9e 100644 --- a/packages/client-analytics/model/dailyRevenue.ts +++ b/packages/client-analytics/model/dailyRevenue.ts @@ -4,7 +4,7 @@ import type { CurrencyCode } from './currencyCode'; export type DailyRevenue = { /** - * Revenue associated with this search, broken-down by currencies. + * Revenue associated with this search: broken down by currency. */ currencies: { [key: string]: CurrencyCode }; diff --git a/packages/client-analytics/model/getAddToCartRateResponse.ts b/packages/client-analytics/model/getAddToCartRateResponse.ts index da26521c4..7ee441596 100644 --- a/packages/client-analytics/model/getAddToCartRateResponse.ts +++ b/packages/client-analytics/model/getAddToCartRateResponse.ts @@ -4,7 +4,7 @@ import type { DailyAddToCartRates } from './dailyAddToCartRates'; export type GetAddToCartRateResponse = { /** - * Add-to-cart rate, calculated as number of tracked searches with at least one add-to-cart event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true. + * Add-to-cart rate: calculated as the number of tracked searches with at least one add-to-cart event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true. */ rate: number | null; diff --git a/packages/client-analytics/model/getClickThroughRateResponse.ts b/packages/client-analytics/model/getClickThroughRateResponse.ts index b57e7b4e4..1d11f2b53 100644 --- a/packages/client-analytics/model/getClickThroughRateResponse.ts +++ b/packages/client-analytics/model/getClickThroughRateResponse.ts @@ -4,7 +4,7 @@ import type { DailyClickThroughRates } from './dailyClickThroughRates'; export type GetClickThroughRateResponse = { /** - * Click-through rate, calculated as number of tracked searches with at least one click event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true. + * Click-through rate: calculated as the number of tracked searches with at least one click event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true. */ rate: number | null; diff --git a/packages/client-analytics/model/getConversionRateResponse.ts b/packages/client-analytics/model/getConversionRateResponse.ts index 572a42827..a95863874 100644 --- a/packages/client-analytics/model/getConversionRateResponse.ts +++ b/packages/client-analytics/model/getConversionRateResponse.ts @@ -4,7 +4,7 @@ import type { DailyConversionRates } from './dailyConversionRates'; export type GetConversionRateResponse = { /** - * Conversion rate, calculated as number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true. + * Conversion rate: calculated as the number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true. */ rate: number | null; diff --git a/packages/client-analytics/model/getNoClickRateResponse.ts b/packages/client-analytics/model/getNoClickRateResponse.ts index cd2bcfbeb..d57236034 100644 --- a/packages/client-analytics/model/getNoClickRateResponse.ts +++ b/packages/client-analytics/model/getNoClickRateResponse.ts @@ -4,7 +4,7 @@ import type { DailyNoClickRates } from './dailyNoClickRates'; export type GetNoClickRateResponse = { /** - * No click rate, calculated as number of tracked searches without any click divided by the number of tracked searches. + * No click rate: calculated as the number of tracked searches without clicks divided by the number of tracked searches. */ rate: number; diff --git a/packages/client-analytics/model/getNoResultsRateResponse.ts b/packages/client-analytics/model/getNoResultsRateResponse.ts index b3317852b..c6e4810e9 100644 --- a/packages/client-analytics/model/getNoResultsRateResponse.ts +++ b/packages/client-analytics/model/getNoResultsRateResponse.ts @@ -4,7 +4,7 @@ import type { DailyNoResultsRates } from './dailyNoResultsRates'; export type GetNoResultsRateResponse = { /** - * No results rate, calculated as number of searches with zero results divided by the total number of searches. + * No results rate: calculated as the number of searches with zero results divided by the total number of searches. */ rate: number; diff --git a/packages/client-analytics/model/getPurchaseRateResponse.ts b/packages/client-analytics/model/getPurchaseRateResponse.ts index e7be52ce5..f4ca5b889 100644 --- a/packages/client-analytics/model/getPurchaseRateResponse.ts +++ b/packages/client-analytics/model/getPurchaseRateResponse.ts @@ -4,7 +4,7 @@ import type { DailyPurchaseRates } from './dailyPurchaseRates'; export type GetPurchaseRateResponse = { /** - * Purchase rate, calculated as number of tracked searches with at least one purchase event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true. + * Purchase rate: calculated as the number of tracked searches with at least one purchase event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true. */ rate: number | null; diff --git a/packages/client-analytics/model/getRevenue.ts b/packages/client-analytics/model/getRevenue.ts index 44d186ece..72be26323 100644 --- a/packages/client-analytics/model/getRevenue.ts +++ b/packages/client-analytics/model/getRevenue.ts @@ -5,7 +5,7 @@ import type { DailyRevenue } from './dailyRevenue'; export type GetRevenue = { /** - * Revenue associated with this search, broken-down by currencies. + * Revenue associated with this search: broken down by currency. */ currencies: { [key: string]: CurrencyCode }; diff --git a/packages/client-analytics/model/getTopFiltersNoResultsResponse.ts b/packages/client-analytics/model/getTopFiltersNoResultsResponse.ts index 76c463f6f..b3cc8d3e4 100644 --- a/packages/client-analytics/model/getTopFiltersNoResultsResponse.ts +++ b/packages/client-analytics/model/getTopFiltersNoResultsResponse.ts @@ -4,7 +4,7 @@ import type { GetTopFiltersNoResultsValues } from './getTopFiltersNoResultsValue export type GetTopFiltersNoResultsResponse = { /** - * Filters for searches without any results. If null, the search term specified with the `search` parameter is not a search without results, or the `search` parameter is absent from the request. + * Filters for searches without any results. If null, the search term specified with the `search` parameter isn\'t a search without results, or the `search` parameter is absent from the request. */ values: Array | null; }; diff --git a/packages/client-analytics/model/topHit.ts b/packages/client-analytics/model/topHit.ts index 16ad93611..7f003f3d8 100644 --- a/packages/client-analytics/model/topHit.ts +++ b/packages/client-analytics/model/topHit.ts @@ -2,7 +2,7 @@ export type TopHit = { /** - * Object ID of a record that\'s returned as a search result. + * Object ID of a record returned as a search result. */ hit: string; diff --git a/packages/client-analytics/model/topHitWithAnalytics.ts b/packages/client-analytics/model/topHitWithAnalytics.ts index 6182522eb..7069ec8df 100644 --- a/packages/client-analytics/model/topHitWithAnalytics.ts +++ b/packages/client-analytics/model/topHitWithAnalytics.ts @@ -2,7 +2,7 @@ export type TopHitWithAnalytics = { /** - * Object ID of a record that\'s returned as a search result. + * Object ID of a record returned as a search result. */ hit: string; @@ -12,12 +12,12 @@ export type TopHitWithAnalytics = { count: number; /** - * Click-through rate, calculated as number of tracked searches with at least one click event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true. + * Click-through rate: calculated as the number of tracked searches with at least one click event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true. */ clickThroughRate: number | null; /** - * Conversion rate, calculated as number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true. + * Conversion rate: calculated as the number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true. */ conversionRate: number | null; diff --git a/packages/client-analytics/model/topHitWithRevenueAnalytics.ts b/packages/client-analytics/model/topHitWithRevenueAnalytics.ts index b66291004..0edde9367 100644 --- a/packages/client-analytics/model/topHitWithRevenueAnalytics.ts +++ b/packages/client-analytics/model/topHitWithRevenueAnalytics.ts @@ -4,7 +4,7 @@ import type { CurrencyCode } from './currencyCode'; export type TopHitWithRevenueAnalytics = { /** - * Object ID of a record that\'s returned as a search result. + * Object ID of a record returned as a search result. */ hit: string; @@ -14,12 +14,12 @@ export type TopHitWithRevenueAnalytics = { count: number; /** - * Click-through rate, calculated as number of tracked searches with at least one click event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true. + * Click-through rate: calculated as the number of tracked searches with at least one click event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true. */ clickThroughRate: number | null; /** - * Conversion rate, calculated as number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true. + * Conversion rate: calculated as the number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true. */ conversionRate: number | null; @@ -39,7 +39,7 @@ export type TopHitWithRevenueAnalytics = { conversionCount: number; /** - * Add-to-cart rate, calculated as number of tracked searches with at least one add-to-cart event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true. + * Add-to-cart rate: calculated as the number of tracked searches with at least one add-to-cart event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true. */ addToCartRate: number | null; @@ -49,7 +49,7 @@ export type TopHitWithRevenueAnalytics = { addToCartCount: number; /** - * Purchase rate, calculated as number of tracked searches with at least one purchase event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true. + * Purchase rate: calculated as the number of tracked searches with at least one purchase event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true. */ purchaseRate: number | null; @@ -59,7 +59,7 @@ export type TopHitWithRevenueAnalytics = { purchaseCount: number; /** - * Revenue associated with this search, broken-down by currencies. + * Revenue associated with this search: broken down by currency. */ currencies: { [key: string]: CurrencyCode }; }; diff --git a/packages/client-analytics/model/topSearchWithAnalytics.ts b/packages/client-analytics/model/topSearchWithAnalytics.ts index 9c71adf85..911769cb5 100644 --- a/packages/client-analytics/model/topSearchWithAnalytics.ts +++ b/packages/client-analytics/model/topSearchWithAnalytics.ts @@ -14,7 +14,7 @@ export type TopSearchWithAnalytics = { count: number; /** - * Click-through rate, calculated as number of tracked searches with at least one click event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true. + * Click-through rate: calculated as the number of tracked searches with at least one click event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true. */ clickThroughRate: number | null; @@ -29,7 +29,7 @@ export type TopSearchWithAnalytics = { clickPositions: Array; /** - * Conversion rate, calculated as number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true. + * Conversion rate: calculated as the number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true. */ conversionRate: number | null; diff --git a/packages/client-analytics/model/topSearchWithRevenueAnalytics.ts b/packages/client-analytics/model/topSearchWithRevenueAnalytics.ts index df6ecda62..55873c453 100644 --- a/packages/client-analytics/model/topSearchWithRevenueAnalytics.ts +++ b/packages/client-analytics/model/topSearchWithRevenueAnalytics.ts @@ -15,7 +15,7 @@ export type TopSearchWithRevenueAnalytics = { count: number; /** - * Click-through rate, calculated as number of tracked searches with at least one click event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true. + * Click-through rate: calculated as the number of tracked searches with at least one click event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true. */ clickThroughRate: number | null; @@ -30,7 +30,7 @@ export type TopSearchWithRevenueAnalytics = { clickPositions: Array; /** - * Conversion rate, calculated as number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true. + * Conversion rate: calculated as the number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true. */ conversionRate: number | null; @@ -55,12 +55,12 @@ export type TopSearchWithRevenueAnalytics = { nbHits: number; /** - * Revenue associated with this search, broken-down by currencies. + * Revenue associated with this search: broken down by currency. */ currencies: { [key: string]: CurrencyCode }; /** - * Add-to-cart rate, calculated as number of tracked searches with at least one add-to-cart event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true. + * Add-to-cart rate: calculated as the number of tracked searches with at least one add-to-cart event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true. */ addToCartRate: number | null; @@ -70,7 +70,7 @@ export type TopSearchWithRevenueAnalytics = { addToCartCount: number; /** - * Purchase rate, calculated as number of tracked searches with at least one purchase event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true. + * Purchase rate: calculated as the number of tracked searches with at least one purchase event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true. */ purchaseRate: number | null; diff --git a/packages/client-analytics/src/analyticsClient.ts b/packages/client-analytics/src/analyticsClient.ts index e72103417..413e22440 100644 --- a/packages/client-analytics/src/analyticsClient.ts +++ b/packages/client-analytics/src/analyticsClient.ts @@ -267,7 +267,7 @@ export function createAnalyticsClient({ }, /** - * Retrieves the add-to-cart rate for all of your searches with at least one add-to-cart event, including a daily breakdown. By default, the analyzed period includes the last eight days including the current day. + * Retrieves the add-to-cart rate for all your searches with at least one add-to-cart event, including a daily breakdown. By default, the analyzed period includes the last eight days including the current day. The rate is the number of add-to-cart conversion events divided by the number of tracked searches. A search is tracked if it returns a queryID (`clickAnalytics` is `true`). This differs from the response\'s `count`, which shows the overall number of searches, including those where `clickAnalytics` is `false`. **There\'s a difference between a 0 and null add-to-cart rate when `clickAnalytics` is enabled:** - **Null** means there were no queries: since Algolia didn\'t receive any events, the add-to-cart rate is null. - **0** mean there _were_ queries but no [add-to-cart events](https://www.algolia.com/doc/guides/sending-events/getting-started/) were received. * * Required API Key ACLs: * - analytics @@ -317,7 +317,7 @@ export function createAnalyticsClient({ }, /** - * Retrieves the average click position of your search results, including a daily breakdown. The average click position is the average of all clicked search results\' positions. For example, if users only ever click on the first result for any search, the average click position is 1. By default, the analyzed period includes the last eight days including the current day. + * Retrieves the average click position of your search results, including a daily breakdown. The average click position is the average of all clicked search result positions. For example, if users only ever click on the first result for any search, the average click position is 1. By default, the analyzed period includes the last eight days including the current day. An average of `null` when `clickAnalytics` is enabled means Algolia didn\'t receive any [click events](https://www.algolia.com/doc/guides/sending-events/getting-started/) for the queries. The average is `null` until Algolia receives at least one click event. * * Required API Key ACLs: * - analytics @@ -367,7 +367,7 @@ export function createAnalyticsClient({ }, /** - * Retrieves the positions in the search results and their associated number of clicks. This lets you check how many clicks the first, second, or tenth search results receive. + * Retrieves the positions in the search results and their associated number of clicks. This lets you check how many clicks the first, second, or tenth search results receive. An average of `0` when `clickAnalytics` is enabled means Algolia didn\'t receive any [click events](https://www.algolia.com/doc/guides/sending-events/getting-started/) for the queries. * * Required API Key ACLs: * - analytics @@ -417,7 +417,7 @@ export function createAnalyticsClient({ }, /** - * Retrieves the click-through rate for all of your searches with at least one click event, including a daily breakdown By default, the analyzed period includes the last eight days including the current day. + * Retrieves the click-through rate (CTR) for all your searches with at least one click event, including a daily breakdown. By default, the analyzed period includes the last eight days including the current day. **There\'s a difference between a 0 and null CTR when `clickAnalytics` is enabled:** - **Null** means there were no queries: since Algolia didn\'t receive any events, CTR is null. - **0** mean there _were_ queries but no [click events](https://www.algolia.com/doc/guides/sending-events/getting-started/) were received. * * Required API Key ACLs: * - analytics @@ -467,7 +467,7 @@ export function createAnalyticsClient({ }, /** - * Retrieves the conversion rate for all of your searches with at least one conversion event, including a daily breakdown. By default, the analyzed period includes the last eight days including the current day. + * Retrieves the conversion rate (CR) for all your searches with at least one conversion event, including a daily breakdown. By default, the analyzed period includes the last eight days including the current day. **There\'s a difference between a 0 and null CR when `clickAnalytics` is enabled:** - **Null** means there were no queries: since Algolia didn\'t receive any events, CR is null. - **0** mean there _were_ queries but no [conversion events](https://www.algolia.com/doc/guides/sending-events/getting-started/) were received. * * Required API Key ACLs: * - analytics @@ -517,7 +517,7 @@ export function createAnalyticsClient({ }, /** - * Retrieves the fraction of searches that didn\'t lead to any click within a time range, including a daily breakdown. By default, the analyzed period includes the last eight days including the current day. + * Retrieves the fraction of searches that didn\'t lead to any click within a time range, including a daily breakdown. It also returns the number of tracked searches and tracked searches without clicks. By default, the analyzed period includes the last eight days including the current day. * * Required API Key ACLs: * - analytics @@ -567,7 +567,7 @@ export function createAnalyticsClient({ }, /** - * Retrieves the fraction of searches that didn\'t return any results within a time range, including a daily breakdown. By default, the analyzed period includes the last eight days including the current day. + * Retrieves the fraction of searches that didn\'t return any results within a time range, including a daily breakdown. It also returns the count of searches and searches without results used to compute the rates. By default, the analyzed period includes the last eight days including the current day. * * Required API Key ACLs: * - analytics @@ -617,7 +617,7 @@ export function createAnalyticsClient({ }, /** - * Retrieves the purchase rate for all of your searches with at least one purchase event, including a daily breakdown. By default, the analyzed period includes the last eight days including the current day. + * Retrieves the purchase rate for all your searches with at least one purchase event, including a daily breakdown. By default, the analyzed period includes the last eight days including the current day. The rate is the number of purchase conversion events divided by the number of tracked searches. A search is tracked if it returns a query ID (`clickAnalytics` is `true`). This differs from the response\'s `count`, which shows the overall number of searches, including those where `clickAnalytics` is `false`. **There\'s a difference between a 0 and null purchase rate when `clickAnalytics` is enabled:** - **Null** means there were no queries: since Algolia didn\'t receive any events, the purchase rate is null. - **0** mean there _were_ queries but no [purchase conversion events](https://www.algolia.com/doc/guides/sending-events/getting-started/) were received. * * Required API Key ACLs: * - analytics @@ -667,7 +667,7 @@ export function createAnalyticsClient({ }, /** - * Retrieves revenue-related metrics, such as the total revenue or the average order value. To retrieve revenue-related metrics, sent purchase events. By default, the analyzed period includes the last eight days including the current day. + * Retrieves revenue-related metrics, such as the total revenue or the average order value. To retrieve revenue-related metrics, send purchase events. By default, the analyzed period includes the last eight days including the current day. Revenue is based on purchase conversion events (a conversion event with an `eventSubtype` attribute of `purchase`). The revenue is the `price` attribute multiplied by the `quantity` attribute for each object in the event\'s `objectData` array. * * Required API Key ACLs: * - analytics @@ -767,7 +767,7 @@ export function createAnalyticsClient({ }, /** - * Retrieves the most popular searches that didn\'t lead to any clicks, from the 1,000 most frequent searches. + * Retrieves the most popular searches that didn\'t lead to any clicks, from the 1,000 most frequent searches. For each search, it also returns the number of displayed search results that remained unclicked. * * Required API Key ACLs: * - analytics @@ -827,7 +827,7 @@ export function createAnalyticsClient({ }, /** - * Retrieves the most popular searches that didn\'t return any results. + * Retrieves the 1,000 most frequent searches that produced zero results. * * Required API Key ACLs: * - analytics @@ -887,7 +887,7 @@ export function createAnalyticsClient({ }, /** - * Retrieves the time when the Analytics data for the specified index was last updated. The Analytics data is updated every 5 minutes. + * Retrieves the time when the Analytics data for the specified index was last updated. If the index has been recently created or no search has been performed yet the updated time is `null`. The Analytics data is updated every 5 minutes. * * Required API Key ACLs: * - analytics @@ -919,7 +919,7 @@ export function createAnalyticsClient({ }, /** - * Retrieves the countries with the most searches to your index. + * Retrieves the countries with the most searches in your index. * * Required API Key ACLs: * - analytics @@ -979,7 +979,7 @@ export function createAnalyticsClient({ }, /** - * Retrieves the most frequently used filter attributes. These are attributes of your records that you included in the `attributesForFaceting` setting. + * Retrieves the 1,000 most frequently used filter attributes. These are attributes of your records that you included in the `attributesForFaceting` setting. * * Required API Key ACLs: * - analytics @@ -1044,7 +1044,7 @@ export function createAnalyticsClient({ }, /** - * Retrieves the most frequent filter (facet) values for a filter attribute. These are attributes of your records that you included in the `attributesForFaceting` setting. + * Retrieves the 1,000 most frequent filter (facet) values for a filter attribute. These are attributes of your records that you included in the `attributesForFaceting` setting. * * Required API Key ACLs: * - analytics @@ -1114,7 +1114,7 @@ export function createAnalyticsClient({ }, /** - * Retrieves the most frequently used filters for a search that didn\'t return any results. To get the most frequent searches without results, use the [Retrieve searches without results](#tag/search/operation/getSearchesNoResults) operation. + * Retrieves the 1,000 most frequently used filters for a search that didn\'t return any results. To get the most frequent searches without results, use the [Retrieve searches without results](#tag/search/operation/getSearchesNoResults) operation. * * Required API Key ACLs: * - analytics @@ -1179,7 +1179,7 @@ export function createAnalyticsClient({ }, /** - * Retrieves the object IDs of the most frequent search results. + * Retrieves the object IDs of the 1,000 most frequent search results. If you set the `clickAnalytics` query parameter to true, the response also includes: - Tracked searches count. Tracked searches are Search API requests with the `clickAnalytics` parameter set to `true`. This differs from the response\'s `count`, which shows the overall number of searches, including those where `clickAnalytics` is `false`. - Click count - Click-through rate (CTR) - Conversion count - Conversion rate (CR) - Average click position If you set the `revenueAnalytics` parameter to `true`, the response also includes: - Add-to-cart count - Add-to-cart rate (ATCR) - Purchase count - Purchase rate - Revenue details for each currency **There\'s a difference between 0% rates and null rates:** - **Null** means there were no queries: since Algolia didn\'t receive any events, the rates (CTR, CR, ATCR, purchase rate) are null. - **0% rates** mean there _were_ queries but no [click or conversion events](https://www.algolia.com/doc/guides/sending-events/getting-started/) were received. * * Required API Key ACLs: * - analytics @@ -1187,7 +1187,7 @@ export function createAnalyticsClient({ * @param getTopHits.index - Index name. * @param getTopHits.search - Search query. * @param getTopHits.clickAnalytics - Whether to include metrics related to click and conversion events in the response. - * @param getTopHits.revenueAnalytics - Whether to include revenue-related metrics in the response. If true, metrics related to click and conversion events are also included in the response. + * @param getTopHits.revenueAnalytics - Whether to include metrics related to revenue events in the response. * @param getTopHits.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. * @param getTopHits.endDate - End date of the period to analyze, in `YYYY-MM-DD` format. * @param getTopHits.limit - Number of items to return. @@ -1254,14 +1254,14 @@ export function createAnalyticsClient({ }, /** - * Returns the most popular search terms. + * Returns the most popular searches. For each search, it also includes the average number of hits. If you set the `clickAnalytics` query parameter to `true`, the response also includes - Tracked searches count. Tracked searches are Search API requests with the `clickAnalytics` parameter set to `true`. This differs from the response\'s `count`, which shows the overall number of searches, including those where `clickAnalytics` is `false`. - Click count - Click-through rate (CTR) - Conversion count - Conversion rate (CR) - Average click position If you set the `revenueAnalytics` query parameter to `true`, the response also includes: - Add-to-cart count - Add-to-cart rate (ATCR) - Purchase count - Purchase rate - Revenue details for each currency **There\'s a difference between 0% rates and null rates:** - **Null** means there were no queries: since Algolia didn\'t receive any events, the rates (CTR, CR, ATCR, purchase rate) are null. - **0% rates** mean there _were_ queries but no [click or conversion events](https://www.algolia.com/doc/guides/sending-events/getting-started/) were received. * * Required API Key ACLs: * - analytics * @param getTopSearches - The getTopSearches object. * @param getTopSearches.index - Index name. * @param getTopSearches.clickAnalytics - Whether to include metrics related to click and conversion events in the response. - * @param getTopSearches.revenueAnalytics - Whether to include revenue-related metrics in the response. If true, metrics related to click and conversion events are also included in the response. + * @param getTopSearches.revenueAnalytics - Whether to include metrics related to revenue events in the response. * @param getTopSearches.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. * @param getTopSearches.endDate - End date of the period to analyze, in `YYYY-MM-DD` format. * @param getTopSearches.orderBy - Attribute by which to order the response items. If the `clickAnalytics` parameter is false, only `searchCount` is available. @@ -1345,7 +1345,7 @@ export function createAnalyticsClient({ }, /** - * Retrieves the number of unique users within a time range, including a daily breakdown. Since this endpoint returns the number of unique users, the sum of the daily values might be different from the total number. By default, Algolia distinguishes search users by their IP address, _unless_ you include a pseudonymous user identifier in your search requests with the `userToken` API parameter or `x-algolia-usertoken` request header. By default, the analyzed period includes the last eight days including the current day. + * Retrieves the number of unique users within a time range, including a daily breakdown. Since it returns the number of unique users, the sum of the daily values might be different from the total number. By default: - Algolia distinguishes search users by their IP address, _unless_ you include a pseudonymous user identifier in your search requests with the `userToken` API parameter or `x-algolia-usertoken` request header. - The analyzed period includes the last eight days including the current day. * * Required API Key ACLs: * - analytics