diff --git a/client/src/commonMain/kotlin/com/algolia/client/api/AnalyticsClient.kt b/client/src/commonMain/kotlin/com/algolia/client/api/AnalyticsClient.kt index ba72b667..f0d35868 100644 --- a/client/src/commonMain/kotlin/com/algolia/client/api/AnalyticsClient.kt +++ b/client/src/commonMain/kotlin/com/algolia/client/api/AnalyticsClient.kt @@ -118,7 +118,7 @@ public class AnalyticsClient( } /** - * 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 @@ -147,7 +147,7 @@ public class AnalyticsClient( } /** - * 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 @@ -176,7 +176,7 @@ public class AnalyticsClient( } /** - * 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 @@ -205,7 +205,7 @@ public class AnalyticsClient( } /** - * 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 @@ -234,7 +234,7 @@ public class AnalyticsClient( } /** - * 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 @@ -263,7 +263,7 @@ public class AnalyticsClient( } /** - * 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 @@ -292,7 +292,7 @@ public class AnalyticsClient( } /** - * 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 @@ -321,7 +321,7 @@ public class AnalyticsClient( } /** - * 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 @@ -350,7 +350,7 @@ public class AnalyticsClient( } /** - * 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 @@ -408,7 +408,7 @@ public class AnalyticsClient( } /** - * 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 @@ -441,7 +441,7 @@ public class AnalyticsClient( } /** - * 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 @@ -474,7 +474,7 @@ public class AnalyticsClient( } /** - * 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 @@ -497,7 +497,7 @@ public class AnalyticsClient( } /** - * 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 @@ -530,7 +530,7 @@ public class AnalyticsClient( } /** - * 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 @@ -565,7 +565,7 @@ public class AnalyticsClient( } /** - * 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 @@ -602,7 +602,7 @@ public class AnalyticsClient( } /** - * 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 @@ -637,14 +637,14 @@ public class AnalyticsClient( } /** - * 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 * @param index Index name. * @param search Search query. * @param clickAnalytics Whether to include metrics related to click and conversion events in the response. (default to false) - * @param 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. (default to false) + * @param revenueAnalytics Whether to include metrics related to revenue events in the response. (default to false) * @param startDate Start date of the period to analyze, in `YYYY-MM-DD` format. * @param endDate End date of the period to analyze, in `YYYY-MM-DD` format. * @param limit Number of items to return. (default to 10) @@ -676,13 +676,13 @@ public class AnalyticsClient( } /** - * 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 index Index name. * @param clickAnalytics Whether to include metrics related to click and conversion events in the response. (default to false) - * @param 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. (default to false) + * @param revenueAnalytics Whether to include metrics related to revenue events in the response. (default to false) * @param startDate Start date of the period to analyze, in `YYYY-MM-DD` format. * @param endDate End date of the period to analyze, in `YYYY-MM-DD` format. * @param orderBy Attribute by which to order the response items. If the `clickAnalytics` parameter is false, only `searchCount` is available. (default to searchCount) @@ -717,7 +717,7 @@ public class AnalyticsClient( } /** - * 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 diff --git a/client/src/commonMain/kotlin/com/algolia/client/model/analytics/DailyAddToCartRates.kt b/client/src/commonMain/kotlin/com/algolia/client/model/analytics/DailyAddToCartRates.kt index dce783c4..11612846 100644 --- a/client/src/commonMain/kotlin/com/algolia/client/model/analytics/DailyAddToCartRates.kt +++ b/client/src/commonMain/kotlin/com/algolia/client/model/analytics/DailyAddToCartRates.kt @@ -7,7 +7,7 @@ import kotlinx.serialization.json.* /** * DailyAddToCartRates * - * @param rate 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. + * @param rate 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. * @param trackedSearchCount Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. * @param addToCartCount Number of add-to-cart events from this search. * @param date Date in the format YYYY-MM-DD. @@ -15,7 +15,7 @@ import kotlinx.serialization.json.* @Serializable public data class 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. */ @SerialName(value = "rate") val rate: Double, /** Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. */ diff --git a/client/src/commonMain/kotlin/com/algolia/client/model/analytics/DailyClickThroughRates.kt b/client/src/commonMain/kotlin/com/algolia/client/model/analytics/DailyClickThroughRates.kt index 54a11c77..d3dc3440 100644 --- a/client/src/commonMain/kotlin/com/algolia/client/model/analytics/DailyClickThroughRates.kt +++ b/client/src/commonMain/kotlin/com/algolia/client/model/analytics/DailyClickThroughRates.kt @@ -7,7 +7,7 @@ import kotlinx.serialization.json.* /** * DailyClickThroughRates * - * @param rate 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. + * @param rate 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. * @param clickCount Number of clicks associated with this search. * @param trackedSearchCount Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. * @param date Date in the format YYYY-MM-DD. @@ -15,7 +15,7 @@ import kotlinx.serialization.json.* @Serializable public data class 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. */ @SerialName(value = "rate") val rate: Double, /** Number of clicks associated with this search. */ diff --git a/client/src/commonMain/kotlin/com/algolia/client/model/analytics/DailyConversionRates.kt b/client/src/commonMain/kotlin/com/algolia/client/model/analytics/DailyConversionRates.kt index b3d15ff3..b69224c8 100644 --- a/client/src/commonMain/kotlin/com/algolia/client/model/analytics/DailyConversionRates.kt +++ b/client/src/commonMain/kotlin/com/algolia/client/model/analytics/DailyConversionRates.kt @@ -7,7 +7,7 @@ import kotlinx.serialization.json.* /** * DailyConversionRates * - * @param rate 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. + * @param rate 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. * @param trackedSearchCount Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. * @param conversionCount Number of conversions from this search. * @param date Date in the format YYYY-MM-DD. @@ -15,7 +15,7 @@ import kotlinx.serialization.json.* @Serializable public data class 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. */ @SerialName(value = "rate") val rate: Double, /** Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. */ diff --git a/client/src/commonMain/kotlin/com/algolia/client/model/analytics/DailyNoClickRates.kt b/client/src/commonMain/kotlin/com/algolia/client/model/analytics/DailyNoClickRates.kt index b001a7c4..87365ae7 100644 --- a/client/src/commonMain/kotlin/com/algolia/client/model/analytics/DailyNoClickRates.kt +++ b/client/src/commonMain/kotlin/com/algolia/client/model/analytics/DailyNoClickRates.kt @@ -7,7 +7,7 @@ import kotlinx.serialization.json.* /** * DailyNoClickRates * - * @param rate No click rate, calculated as number of tracked searches without any click divided by the number of tracked searches. + * @param rate No click rate: calculated as the number of tracked searches without clicks divided by the number of tracked searches. * @param count Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. * @param noClickCount Number of times this search was returned as a result without any click. * @param date Date in the format YYYY-MM-DD. @@ -15,7 +15,7 @@ import kotlinx.serialization.json.* @Serializable public data class 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. */ @SerialName(value = "rate") val rate: Double, /** Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. */ diff --git a/client/src/commonMain/kotlin/com/algolia/client/model/analytics/DailyNoResultsRates.kt b/client/src/commonMain/kotlin/com/algolia/client/model/analytics/DailyNoResultsRates.kt index 73bc8f2c..81258412 100644 --- a/client/src/commonMain/kotlin/com/algolia/client/model/analytics/DailyNoResultsRates.kt +++ b/client/src/commonMain/kotlin/com/algolia/client/model/analytics/DailyNoResultsRates.kt @@ -10,7 +10,7 @@ import kotlinx.serialization.json.* * @param date Date in the format YYYY-MM-DD. * @param noResultCount Number of searches without any results. * @param count Number of searches. - * @param rate No results rate, calculated as number of searches with zero results divided by the total number of searches. + * @param rate No results rate: calculated as the number of searches with zero results divided by the total number of searches. */ @Serializable public data class DailyNoResultsRates( @@ -24,6 +24,6 @@ public data class DailyNoResultsRates( /** Number of searches. */ @SerialName(value = "count") val count: Int, - /** 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. */ @SerialName(value = "rate") val rate: Double, ) diff --git a/client/src/commonMain/kotlin/com/algolia/client/model/analytics/DailyPurchaseRates.kt b/client/src/commonMain/kotlin/com/algolia/client/model/analytics/DailyPurchaseRates.kt index 80affa85..56b35782 100644 --- a/client/src/commonMain/kotlin/com/algolia/client/model/analytics/DailyPurchaseRates.kt +++ b/client/src/commonMain/kotlin/com/algolia/client/model/analytics/DailyPurchaseRates.kt @@ -7,7 +7,7 @@ import kotlinx.serialization.json.* /** * DailyPurchaseRates * - * @param rate 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. + * @param rate 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. * @param trackedSearchCount Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. * @param purchaseCount Number of purchase events from this search. * @param date Date in the format YYYY-MM-DD. @@ -15,7 +15,7 @@ import kotlinx.serialization.json.* @Serializable public data class 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. */ @SerialName(value = "rate") val rate: Double, /** Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. */ diff --git a/client/src/commonMain/kotlin/com/algolia/client/model/analytics/DailyRevenue.kt b/client/src/commonMain/kotlin/com/algolia/client/model/analytics/DailyRevenue.kt index 0f2e6767..60bb44d1 100644 --- a/client/src/commonMain/kotlin/com/algolia/client/model/analytics/DailyRevenue.kt +++ b/client/src/commonMain/kotlin/com/algolia/client/model/analytics/DailyRevenue.kt @@ -7,13 +7,13 @@ import kotlinx.serialization.json.* /** * DailyRevenue * - * @param currencies Revenue associated with this search, broken-down by currencies. + * @param currencies Revenue associated with this search: broken down by currency. * @param date Date in the format YYYY-MM-DD. */ @Serializable public data class DailyRevenue( - /** Revenue associated with this search, broken-down by currencies. */ + /** Revenue associated with this search: broken down by currency. */ @SerialName(value = "currencies") val currencies: Map, /** Date in the format YYYY-MM-DD. */ diff --git a/client/src/commonMain/kotlin/com/algolia/client/model/analytics/GetAddToCartRateResponse.kt b/client/src/commonMain/kotlin/com/algolia/client/model/analytics/GetAddToCartRateResponse.kt index f3d793cf..92437e58 100644 --- a/client/src/commonMain/kotlin/com/algolia/client/model/analytics/GetAddToCartRateResponse.kt +++ b/client/src/commonMain/kotlin/com/algolia/client/model/analytics/GetAddToCartRateResponse.kt @@ -7,7 +7,7 @@ import kotlinx.serialization.json.* /** * GetAddToCartRateResponse * - * @param rate 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. + * @param rate 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. * @param trackedSearchCount Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. * @param addToCartCount Number of add-to-cart events from this search. * @param dates Daily add-to-cart rates. @@ -15,7 +15,7 @@ import kotlinx.serialization.json.* @Serializable public data class 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. */ @SerialName(value = "rate") val rate: Double, /** Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. */ diff --git a/client/src/commonMain/kotlin/com/algolia/client/model/analytics/GetClickThroughRateResponse.kt b/client/src/commonMain/kotlin/com/algolia/client/model/analytics/GetClickThroughRateResponse.kt index 2b715f6a..290f94f8 100644 --- a/client/src/commonMain/kotlin/com/algolia/client/model/analytics/GetClickThroughRateResponse.kt +++ b/client/src/commonMain/kotlin/com/algolia/client/model/analytics/GetClickThroughRateResponse.kt @@ -7,7 +7,7 @@ import kotlinx.serialization.json.* /** * GetClickThroughRateResponse * - * @param rate 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. + * @param rate 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. * @param clickCount Number of clicks associated with this search. * @param trackedSearchCount Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. * @param dates Daily click-through rates. @@ -15,7 +15,7 @@ import kotlinx.serialization.json.* @Serializable public data class 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. */ @SerialName(value = "rate") val rate: Double, /** Number of clicks associated with this search. */ diff --git a/client/src/commonMain/kotlin/com/algolia/client/model/analytics/GetConversionRateResponse.kt b/client/src/commonMain/kotlin/com/algolia/client/model/analytics/GetConversionRateResponse.kt index 5e775322..115d8d93 100644 --- a/client/src/commonMain/kotlin/com/algolia/client/model/analytics/GetConversionRateResponse.kt +++ b/client/src/commonMain/kotlin/com/algolia/client/model/analytics/GetConversionRateResponse.kt @@ -7,7 +7,7 @@ import kotlinx.serialization.json.* /** * GetConversionRateResponse * - * @param rate 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. + * @param rate 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. * @param trackedSearchCount Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. * @param conversionCount Number of conversions from this search. * @param dates Daily conversion rates. @@ -15,7 +15,7 @@ import kotlinx.serialization.json.* @Serializable public data class 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. */ @SerialName(value = "rate") val rate: Double, /** Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. */ diff --git a/client/src/commonMain/kotlin/com/algolia/client/model/analytics/GetNoClickRateResponse.kt b/client/src/commonMain/kotlin/com/algolia/client/model/analytics/GetNoClickRateResponse.kt index a73ed1c6..6067da66 100644 --- a/client/src/commonMain/kotlin/com/algolia/client/model/analytics/GetNoClickRateResponse.kt +++ b/client/src/commonMain/kotlin/com/algolia/client/model/analytics/GetNoClickRateResponse.kt @@ -7,7 +7,7 @@ import kotlinx.serialization.json.* /** * GetNoClickRateResponse * - * @param rate No click rate, calculated as number of tracked searches without any click divided by the number of tracked searches. + * @param rate No click rate: calculated as the number of tracked searches without clicks divided by the number of tracked searches. * @param count Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. * @param noClickCount Number of times this search was returned as a result without any click. * @param dates Daily no click rates. @@ -15,7 +15,7 @@ import kotlinx.serialization.json.* @Serializable public data class 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. */ @SerialName(value = "rate") val rate: Double, /** Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. */ diff --git a/client/src/commonMain/kotlin/com/algolia/client/model/analytics/GetNoResultsRateResponse.kt b/client/src/commonMain/kotlin/com/algolia/client/model/analytics/GetNoResultsRateResponse.kt index 2c43b013..9c20641c 100644 --- a/client/src/commonMain/kotlin/com/algolia/client/model/analytics/GetNoResultsRateResponse.kt +++ b/client/src/commonMain/kotlin/com/algolia/client/model/analytics/GetNoResultsRateResponse.kt @@ -7,7 +7,7 @@ import kotlinx.serialization.json.* /** * GetNoResultsRateResponse * - * @param rate No results rate, calculated as number of searches with zero results divided by the total number of searches. + * @param rate No results rate: calculated as the number of searches with zero results divided by the total number of searches. * @param count Number of searches. * @param noResultCount Number of searches without any results. * @param dates Daily no results rates. @@ -15,7 +15,7 @@ import kotlinx.serialization.json.* @Serializable public data class 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. */ @SerialName(value = "rate") val rate: Double, /** Number of searches. */ diff --git a/client/src/commonMain/kotlin/com/algolia/client/model/analytics/GetPurchaseRateResponse.kt b/client/src/commonMain/kotlin/com/algolia/client/model/analytics/GetPurchaseRateResponse.kt index 31eee442..86a36d78 100644 --- a/client/src/commonMain/kotlin/com/algolia/client/model/analytics/GetPurchaseRateResponse.kt +++ b/client/src/commonMain/kotlin/com/algolia/client/model/analytics/GetPurchaseRateResponse.kt @@ -7,7 +7,7 @@ import kotlinx.serialization.json.* /** * GetPurchaseRateResponse * - * @param rate 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. + * @param rate 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. * @param trackedSearchCount Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. * @param purchaseCount Number of purchase events from this search. * @param dates Daily purchase rates. @@ -15,7 +15,7 @@ import kotlinx.serialization.json.* @Serializable public data class 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. */ @SerialName(value = "rate") val rate: Double, /** Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. */ diff --git a/client/src/commonMain/kotlin/com/algolia/client/model/analytics/GetRevenue.kt b/client/src/commonMain/kotlin/com/algolia/client/model/analytics/GetRevenue.kt index 58d26bb8..64a9a672 100644 --- a/client/src/commonMain/kotlin/com/algolia/client/model/analytics/GetRevenue.kt +++ b/client/src/commonMain/kotlin/com/algolia/client/model/analytics/GetRevenue.kt @@ -7,13 +7,13 @@ import kotlinx.serialization.json.* /** * GetRevenue * - * @param currencies Revenue associated with this search, broken-down by currencies. + * @param currencies Revenue associated with this search: broken down by currency. * @param dates Daily revenue. */ @Serializable public data class GetRevenue( - /** Revenue associated with this search, broken-down by currencies. */ + /** Revenue associated with this search: broken down by currency. */ @SerialName(value = "currencies") val currencies: Map, /** Daily revenue. */ diff --git a/client/src/commonMain/kotlin/com/algolia/client/model/analytics/GetTopFiltersNoResultsResponse.kt b/client/src/commonMain/kotlin/com/algolia/client/model/analytics/GetTopFiltersNoResultsResponse.kt index 4728fc95..84a2ebf5 100644 --- a/client/src/commonMain/kotlin/com/algolia/client/model/analytics/GetTopFiltersNoResultsResponse.kt +++ b/client/src/commonMain/kotlin/com/algolia/client/model/analytics/GetTopFiltersNoResultsResponse.kt @@ -7,11 +7,11 @@ import kotlinx.serialization.json.* /** * GetTopFiltersNoResultsResponse * - * @param values 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. + * @param values 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. */ @Serializable public data class 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. */ @SerialName(value = "values") val values: List, ) diff --git a/client/src/commonMain/kotlin/com/algolia/client/model/analytics/TopHit.kt b/client/src/commonMain/kotlin/com/algolia/client/model/analytics/TopHit.kt index b4a8d58e..f62957ef 100644 --- a/client/src/commonMain/kotlin/com/algolia/client/model/analytics/TopHit.kt +++ b/client/src/commonMain/kotlin/com/algolia/client/model/analytics/TopHit.kt @@ -7,13 +7,13 @@ import kotlinx.serialization.json.* /** * TopHit * - * @param hit Object ID of a record that's returned as a search result. + * @param hit Object ID of a record returned as a search result. * @param count Number of occurrences. */ @Serializable public data class TopHit( - /** Object ID of a record that's returned as a search result. */ + /** Object ID of a record returned as a search result. */ @SerialName(value = "hit") val hit: String, /** Number of occurrences. */ diff --git a/client/src/commonMain/kotlin/com/algolia/client/model/analytics/TopHitWithAnalytics.kt b/client/src/commonMain/kotlin/com/algolia/client/model/analytics/TopHitWithAnalytics.kt index 6d76865c..1763f638 100644 --- a/client/src/commonMain/kotlin/com/algolia/client/model/analytics/TopHitWithAnalytics.kt +++ b/client/src/commonMain/kotlin/com/algolia/client/model/analytics/TopHitWithAnalytics.kt @@ -7,10 +7,10 @@ import kotlinx.serialization.json.* /** * TopHitWithAnalytics * - * @param hit Object ID of a record that's returned as a search result. + * @param hit Object ID of a record returned as a search result. * @param count Number of occurrences. - * @param clickThroughRate 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. - * @param conversionRate 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. + * @param clickThroughRate 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. + * @param conversionRate 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. * @param trackedHitCount Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. * @param clickCount Number of clicks associated with this search. * @param conversionCount Number of conversions from this search. @@ -18,16 +18,16 @@ import kotlinx.serialization.json.* @Serializable public data class TopHitWithAnalytics( - /** Object ID of a record that's returned as a search result. */ + /** Object ID of a record returned as a search result. */ @SerialName(value = "hit") val hit: String, /** Number of occurrences. */ @SerialName(value = "count") val count: Int, - /** 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. */ @SerialName(value = "clickThroughRate") val clickThroughRate: Double, - /** 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. */ @SerialName(value = "conversionRate") val conversionRate: Double, /** Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. */ diff --git a/client/src/commonMain/kotlin/com/algolia/client/model/analytics/TopHitWithRevenueAnalytics.kt b/client/src/commonMain/kotlin/com/algolia/client/model/analytics/TopHitWithRevenueAnalytics.kt index 349cb0c5..2f18dae0 100644 --- a/client/src/commonMain/kotlin/com/algolia/client/model/analytics/TopHitWithRevenueAnalytics.kt +++ b/client/src/commonMain/kotlin/com/algolia/client/model/analytics/TopHitWithRevenueAnalytics.kt @@ -7,32 +7,32 @@ import kotlinx.serialization.json.* /** * TopHitWithRevenueAnalytics * - * @param hit Object ID of a record that's returned as a search result. + * @param hit Object ID of a record returned as a search result. * @param count Number of occurrences. - * @param clickThroughRate 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. - * @param conversionRate 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. + * @param clickThroughRate 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. + * @param conversionRate 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. * @param trackedHitCount Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. * @param clickCount Number of clicks associated with this search. * @param conversionCount Number of conversions from this search. - * @param addToCartRate 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. + * @param addToCartRate 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. * @param addToCartCount Number of add-to-cart events from this search. - * @param purchaseRate 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. + * @param purchaseRate 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. * @param purchaseCount Number of purchase events from this search. - * @param currencies Revenue associated with this search, broken-down by currencies. + * @param currencies Revenue associated with this search: broken down by currency. */ @Serializable public data class TopHitWithRevenueAnalytics( - /** Object ID of a record that's returned as a search result. */ + /** Object ID of a record returned as a search result. */ @SerialName(value = "hit") val hit: String, /** Number of occurrences. */ @SerialName(value = "count") val count: Int, - /** 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. */ @SerialName(value = "clickThroughRate") val clickThroughRate: Double, - /** 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. */ @SerialName(value = "conversionRate") val conversionRate: Double, /** Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. */ @@ -44,18 +44,18 @@ public data class TopHitWithRevenueAnalytics( /** Number of conversions from this search. */ @SerialName(value = "conversionCount") val conversionCount: Int, - /** 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. */ @SerialName(value = "addToCartRate") val addToCartRate: Double, /** Number of add-to-cart events from this search. */ @SerialName(value = "addToCartCount") val addToCartCount: Int, - /** 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. */ @SerialName(value = "purchaseRate") val purchaseRate: Double, /** Number of purchase events from this search. */ @SerialName(value = "purchaseCount") val purchaseCount: Int, - /** Revenue associated with this search, broken-down by currencies. */ + /** Revenue associated with this search: broken down by currency. */ @SerialName(value = "currencies") val currencies: Map, ) diff --git a/client/src/commonMain/kotlin/com/algolia/client/model/analytics/TopSearchWithAnalytics.kt b/client/src/commonMain/kotlin/com/algolia/client/model/analytics/TopSearchWithAnalytics.kt index 4a830f36..102ed9ce 100644 --- a/client/src/commonMain/kotlin/com/algolia/client/model/analytics/TopSearchWithAnalytics.kt +++ b/client/src/commonMain/kotlin/com/algolia/client/model/analytics/TopSearchWithAnalytics.kt @@ -9,10 +9,10 @@ import kotlinx.serialization.json.* * * @param search Search query. * @param count Number of searches. - * @param clickThroughRate 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. + * @param clickThroughRate 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. * @param averageClickPosition 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. * @param clickPositions List of positions in the search results and clicks associated with this search. - * @param conversionRate 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. + * @param conversionRate 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. * @param trackedSearchCount Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. * @param clickCount Number of clicks associated with this search. * @param conversionCount Number of conversions from this search. @@ -27,7 +27,7 @@ public data class TopSearchWithAnalytics( /** Number of searches. */ @SerialName(value = "count") val count: Int, - /** 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. */ @SerialName(value = "clickThroughRate") val clickThroughRate: Double, /** 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. */ @@ -36,7 +36,7 @@ public data class TopSearchWithAnalytics( /** List of positions in the search results and clicks associated with this search. */ @SerialName(value = "clickPositions") val clickPositions: List, - /** 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. */ @SerialName(value = "conversionRate") val conversionRate: Double, /** Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. */ diff --git a/client/src/commonMain/kotlin/com/algolia/client/model/analytics/TopSearchWithRevenueAnalytics.kt b/client/src/commonMain/kotlin/com/algolia/client/model/analytics/TopSearchWithRevenueAnalytics.kt index 41376f8c..ef19466b 100644 --- a/client/src/commonMain/kotlin/com/algolia/client/model/analytics/TopSearchWithRevenueAnalytics.kt +++ b/client/src/commonMain/kotlin/com/algolia/client/model/analytics/TopSearchWithRevenueAnalytics.kt @@ -9,18 +9,18 @@ import kotlinx.serialization.json.* * * @param search Search query. * @param count Number of searches. - * @param clickThroughRate 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. + * @param clickThroughRate 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. * @param averageClickPosition 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. * @param clickPositions List of positions in the search results and clicks associated with this search. - * @param conversionRate 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. + * @param conversionRate 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. * @param trackedSearchCount Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. * @param clickCount Number of clicks associated with this search. * @param conversionCount Number of conversions from this search. * @param nbHits Number of results (hits). - * @param currencies Revenue associated with this search, broken-down by currencies. - * @param addToCartRate 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. + * @param currencies Revenue associated with this search: broken down by currency. + * @param addToCartRate 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. * @param addToCartCount Number of add-to-cart events from this search. - * @param purchaseRate 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. + * @param purchaseRate 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. * @param purchaseCount Number of purchase events from this search. */ @Serializable @@ -32,7 +32,7 @@ public data class TopSearchWithRevenueAnalytics( /** Number of searches. */ @SerialName(value = "count") val count: Int, - /** 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. */ @SerialName(value = "clickThroughRate") val clickThroughRate: Double, /** 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. */ @@ -41,7 +41,7 @@ public data class TopSearchWithRevenueAnalytics( /** List of positions in the search results and clicks associated with this search. */ @SerialName(value = "clickPositions") val clickPositions: List, - /** 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. */ @SerialName(value = "conversionRate") val conversionRate: Double, /** Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. */ @@ -56,16 +56,16 @@ public data class TopSearchWithRevenueAnalytics( /** Number of results (hits). */ @SerialName(value = "nbHits") val nbHits: Int, - /** Revenue associated with this search, broken-down by currencies. */ + /** Revenue associated with this search: broken down by currency. */ @SerialName(value = "currencies") val currencies: Map, - /** 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. */ @SerialName(value = "addToCartRate") val addToCartRate: Double, /** Number of add-to-cart events from this search. */ @SerialName(value = "addToCartCount") val addToCartCount: Int, - /** 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. */ @SerialName(value = "purchaseRate") val purchaseRate: Double, /** Number of purchase events from this search. */