From 1ee7ff4915b09cd1fdf1a9b866258b630b9d9e15 Mon Sep 17 00:00:00 2001 From: algolia-bot Date: Thu, 16 Jan 2025 10:58:53 +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 --- algoliasearch/Clients/AnalyticsClient.cs | 84 +++++++++---------- .../Clients/AnalyticsConfiguration.cs | 2 +- .../Models/Analytics/DailyAddToCartRates.cs | 6 +- .../Analytics/DailyClickThroughRates.cs | 6 +- .../Models/Analytics/DailyConversionRates.cs | 6 +- .../Models/Analytics/DailyNoClickRates.cs | 6 +- .../Models/Analytics/DailyNoResultsRates.cs | 6 +- .../Models/Analytics/DailyPurchaseRates.cs | 6 +- .../Models/Analytics/DailyRevenue.cs | 6 +- .../Analytics/GetAddToCartRateResponse.cs | 6 +- .../Analytics/GetClickThroughRateResponse.cs | 6 +- .../Analytics/GetConversionRateResponse.cs | 6 +- .../Analytics/GetNoClickRateResponse.cs | 6 +- .../Analytics/GetNoResultsRateResponse.cs | 6 +- .../Analytics/GetPurchaseRateResponse.cs | 6 +- algoliasearch/Models/Analytics/GetRevenue.cs | 6 +- .../GetTopFiltersNoResultsResponse.cs | 6 +- algoliasearch/Models/Analytics/TopHit.cs | 6 +- .../Models/Analytics/TopHitWithAnalytics.cs | 18 ++-- .../Analytics/TopHitWithRevenueAnalytics.cs | 36 ++++---- .../Analytics/TopSearchWithAnalytics.cs | 12 +-- .../TopSearchWithRevenueAnalytics.cs | 30 +++---- 22 files changed, 139 insertions(+), 139 deletions(-) diff --git a/algoliasearch/Clients/AnalyticsClient.cs b/algoliasearch/Clients/AnalyticsClient.cs index 3013f2d50..d04d4cd9a 100644 --- a/algoliasearch/Clients/AnalyticsClient.cs +++ b/algoliasearch/Clients/AnalyticsClient.cs @@ -130,7 +130,7 @@ public interface IAnalyticsClient object CustomPut(string path, Dictionary parameters = default, object body = default, RequestOptions options = null, CancellationToken cancellationToken = default); /// - /// 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: @@ -148,7 +148,7 @@ public interface IAnalyticsClient Task GetAddToCartRateAsync(string index, string startDate = default, string endDate = default, string tags = default, RequestOptions options = null, CancellationToken cancellationToken = default); /// - /// 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. (Synchronous version) + /// 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. (Synchronous version) /// /// /// Required API Key ACLs: @@ -166,7 +166,7 @@ public interface IAnalyticsClient GetAddToCartRateResponse GetAddToCartRate(string index, string startDate = default, string endDate = default, string tags = default, RequestOptions options = null, CancellationToken cancellationToken = default); /// - /// 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: @@ -184,7 +184,7 @@ public interface IAnalyticsClient Task GetAverageClickPositionAsync(string index, string startDate = default, string endDate = default, string tags = default, RequestOptions options = null, CancellationToken cancellationToken = default); /// - /// 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. (Synchronous version) + /// 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. (Synchronous version) /// /// /// Required API Key ACLs: @@ -202,7 +202,7 @@ public interface IAnalyticsClient GetAverageClickPositionResponse GetAverageClickPosition(string index, string startDate = default, string endDate = default, string tags = default, RequestOptions options = null, CancellationToken cancellationToken = default); /// - /// 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: @@ -220,7 +220,7 @@ public interface IAnalyticsClient Task GetClickPositionsAsync(string index, string startDate = default, string endDate = default, string tags = default, RequestOptions options = null, CancellationToken cancellationToken = default); /// - /// 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. (Synchronous version) + /// 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. (Synchronous version) /// /// /// Required API Key ACLs: @@ -238,7 +238,7 @@ public interface IAnalyticsClient GetClickPositionsResponse GetClickPositions(string index, string startDate = default, string endDate = default, string tags = default, RequestOptions options = null, CancellationToken cancellationToken = default); /// - /// 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: @@ -256,7 +256,7 @@ public interface IAnalyticsClient Task GetClickThroughRateAsync(string index, string startDate = default, string endDate = default, string tags = default, RequestOptions options = null, CancellationToken cancellationToken = default); /// - /// 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. (Synchronous version) + /// 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. (Synchronous version) /// /// /// Required API Key ACLs: @@ -274,7 +274,7 @@ public interface IAnalyticsClient GetClickThroughRateResponse GetClickThroughRate(string index, string startDate = default, string endDate = default, string tags = default, RequestOptions options = null, CancellationToken cancellationToken = default); /// - /// 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: @@ -292,7 +292,7 @@ public interface IAnalyticsClient Task GetConversionRateAsync(string index, string startDate = default, string endDate = default, string tags = default, RequestOptions options = null, CancellationToken cancellationToken = default); /// - /// 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. (Synchronous version) + /// 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. (Synchronous version) /// /// /// Required API Key ACLs: @@ -310,7 +310,7 @@ public interface IAnalyticsClient GetConversionRateResponse GetConversionRate(string index, string startDate = default, string endDate = default, string tags = default, RequestOptions options = null, CancellationToken cancellationToken = default); /// - /// 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: @@ -328,7 +328,7 @@ public interface IAnalyticsClient Task GetNoClickRateAsync(string index, string startDate = default, string endDate = default, string tags = default, RequestOptions options = null, CancellationToken cancellationToken = default); /// - /// 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. (Synchronous version) + /// 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. (Synchronous version) /// /// /// Required API Key ACLs: @@ -346,7 +346,7 @@ public interface IAnalyticsClient GetNoClickRateResponse GetNoClickRate(string index, string startDate = default, string endDate = default, string tags = default, RequestOptions options = null, CancellationToken cancellationToken = default); /// - /// 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: @@ -364,7 +364,7 @@ public interface IAnalyticsClient Task GetNoResultsRateAsync(string index, string startDate = default, string endDate = default, string tags = default, RequestOptions options = null, CancellationToken cancellationToken = default); /// - /// 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. (Synchronous version) + /// 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. (Synchronous version) /// /// /// Required API Key ACLs: @@ -382,7 +382,7 @@ public interface IAnalyticsClient GetNoResultsRateResponse GetNoResultsRate(string index, string startDate = default, string endDate = default, string tags = default, RequestOptions options = null, CancellationToken cancellationToken = default); /// - /// 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: @@ -400,7 +400,7 @@ public interface IAnalyticsClient Task GetPurchaseRateAsync(string index, string startDate = default, string endDate = default, string tags = default, RequestOptions options = null, CancellationToken cancellationToken = default); /// - /// 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. (Synchronous version) + /// 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. (Synchronous version) /// /// /// Required API Key ACLs: @@ -418,7 +418,7 @@ public interface IAnalyticsClient GetPurchaseRateResponse GetPurchaseRate(string index, string startDate = default, string endDate = default, string tags = default, RequestOptions options = null, CancellationToken cancellationToken = default); /// - /// 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: @@ -436,7 +436,7 @@ public interface IAnalyticsClient Task GetRevenueAsync(string index, string startDate = default, string endDate = default, string tags = default, RequestOptions options = null, CancellationToken cancellationToken = default); /// - /// 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. (Synchronous version) + /// 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. (Synchronous version) /// /// /// Required API Key ACLs: @@ -490,7 +490,7 @@ public interface IAnalyticsClient GetSearchesCountResponse GetSearchesCount(string index, string startDate = default, string endDate = default, string tags = default, RequestOptions options = null, CancellationToken cancellationToken = default); /// - /// 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: @@ -510,7 +510,7 @@ public interface IAnalyticsClient Task GetSearchesNoClicksAsync(string index, string startDate = default, string endDate = default, int? limit = default, int? offset = default, string tags = default, RequestOptions options = null, CancellationToken cancellationToken = default); /// - /// Retrieves the most popular searches that didn't lead to any clicks, from the 1,000 most frequent searches. (Synchronous version) + /// 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. (Synchronous version) /// /// /// Required API Key ACLs: @@ -530,7 +530,7 @@ public interface IAnalyticsClient GetSearchesNoClicksResponse GetSearchesNoClicks(string index, string startDate = default, string endDate = default, int? limit = default, int? offset = default, string tags = default, RequestOptions options = null, CancellationToken cancellationToken = default); /// - /// 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: @@ -550,7 +550,7 @@ public interface IAnalyticsClient Task GetSearchesNoResultsAsync(string index, string startDate = default, string endDate = default, int? limit = default, int? offset = default, string tags = default, RequestOptions options = null, CancellationToken cancellationToken = default); /// - /// Retrieves the most popular searches that didn't return any results. (Synchronous version) + /// Retrieves the 1,000 most frequent searches that produced zero results. (Synchronous version) /// /// /// Required API Key ACLs: @@ -570,7 +570,7 @@ public interface IAnalyticsClient GetSearchesNoResultsResponse GetSearchesNoResults(string index, string startDate = default, string endDate = default, int? limit = default, int? offset = default, string tags = default, RequestOptions options = null, CancellationToken cancellationToken = default); /// - /// 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: @@ -585,7 +585,7 @@ public interface IAnalyticsClient Task GetStatusAsync(string index, RequestOptions options = null, CancellationToken cancellationToken = default); /// - /// Retrieves the time when the Analytics data for the specified index was last updated. The Analytics data is updated every 5 minutes. (Synchronous version) + /// 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. (Synchronous version) /// /// /// Required API Key ACLs: @@ -600,7 +600,7 @@ public interface IAnalyticsClient GetStatusResponse GetStatus(string index, RequestOptions options = null, CancellationToken cancellationToken = default); /// - /// Retrieves the countries with the most searches to your index. + /// Retrieves the countries with the most searches in your index. /// /// /// Required API Key ACLs: @@ -620,7 +620,7 @@ public interface IAnalyticsClient Task GetTopCountriesAsync(string index, string startDate = default, string endDate = default, int? limit = default, int? offset = default, string tags = default, RequestOptions options = null, CancellationToken cancellationToken = default); /// - /// Retrieves the countries with the most searches to your index. (Synchronous version) + /// Retrieves the countries with the most searches in your index. (Synchronous version) /// /// /// Required API Key ACLs: @@ -640,7 +640,7 @@ public interface IAnalyticsClient GetTopCountriesResponse GetTopCountries(string index, string startDate = default, string endDate = default, int? limit = default, int? offset = default, string tags = default, RequestOptions options = null, CancellationToken cancellationToken = default); /// - /// 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: @@ -661,7 +661,7 @@ public interface IAnalyticsClient Task GetTopFilterAttributesAsync(string index, string search = default, string startDate = default, string endDate = default, int? limit = default, int? offset = default, string tags = default, RequestOptions options = null, CancellationToken cancellationToken = default); /// - /// Retrieves the most frequently used filter attributes. These are attributes of your records that you included in the `attributesForFaceting` setting. (Synchronous version) + /// Retrieves the 1,000 most frequently used filter attributes. These are attributes of your records that you included in the `attributesForFaceting` setting. (Synchronous version) /// /// /// Required API Key ACLs: @@ -682,7 +682,7 @@ public interface IAnalyticsClient GetTopFilterAttributesResponse GetTopFilterAttributes(string index, string search = default, string startDate = default, string endDate = default, int? limit = default, int? offset = default, string tags = default, RequestOptions options = null, CancellationToken cancellationToken = default); /// - /// 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: @@ -704,7 +704,7 @@ public interface IAnalyticsClient Task GetTopFilterForAttributeAsync(string attribute, string index, string search = default, string startDate = default, string endDate = default, int? limit = default, int? offset = default, string tags = default, RequestOptions options = null, CancellationToken cancellationToken = default); /// - /// Retrieves the most frequent filter (facet) values for a filter attribute. These are attributes of your records that you included in the `attributesForFaceting` setting. (Synchronous version) + /// 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. (Synchronous version) /// /// /// Required API Key ACLs: @@ -726,7 +726,7 @@ public interface IAnalyticsClient GetTopFilterForAttributeResponse GetTopFilterForAttribute(string attribute, string index, string search = default, string startDate = default, string endDate = default, int? limit = default, int? offset = default, string tags = default, RequestOptions options = null, CancellationToken cancellationToken = default); /// - /// 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: @@ -747,7 +747,7 @@ public interface IAnalyticsClient Task GetTopFiltersNoResultsAsync(string index, string search = default, string startDate = default, string endDate = default, int? limit = default, int? offset = default, string tags = default, RequestOptions options = null, CancellationToken cancellationToken = default); /// - /// 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. (Synchronous version) + /// 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. (Synchronous version) /// /// /// Required API Key ACLs: @@ -768,7 +768,7 @@ public interface IAnalyticsClient GetTopFiltersNoResultsResponse GetTopFiltersNoResults(string index, string search = default, string startDate = default, string endDate = default, int? limit = default, int? offset = default, string tags = default, RequestOptions options = null, CancellationToken cancellationToken = default); /// - /// 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: @@ -776,7 +776,7 @@ public interface IAnalyticsClient /// Index name. /// Search query. (optional) /// Whether to include metrics related to click and conversion events in the response. (optional, default to false) - /// Whether to include revenue-related metrics in the response. If true, metrics related to click and conversion events are also included in the response. (optional, default to false) + /// Whether to include metrics related to revenue events in the response. (optional, default to false) /// Start date of the period to analyze, in `YYYY-MM-DD` format. (optional) /// End date of the period to analyze, in `YYYY-MM-DD` format. (optional) /// Number of items to return. (optional, default to 10) @@ -791,7 +791,7 @@ public interface IAnalyticsClient Task GetTopHitsAsync(string index, string search = default, bool? clickAnalytics = default, bool? revenueAnalytics = default, string startDate = default, string endDate = default, int? limit = default, int? offset = default, string tags = default, RequestOptions options = null, CancellationToken cancellationToken = default); /// - /// Retrieves the object IDs of the most frequent search results. (Synchronous version) + /// 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. (Synchronous version) /// /// /// Required API Key ACLs: @@ -799,7 +799,7 @@ public interface IAnalyticsClient /// Index name. /// Search query. (optional) /// Whether to include metrics related to click and conversion events in the response. (optional, default to false) - /// Whether to include revenue-related metrics in the response. If true, metrics related to click and conversion events are also included in the response. (optional, default to false) + /// Whether to include metrics related to revenue events in the response. (optional, default to false) /// Start date of the period to analyze, in `YYYY-MM-DD` format. (optional) /// End date of the period to analyze, in `YYYY-MM-DD` format. (optional) /// Number of items to return. (optional, default to 10) @@ -814,14 +814,14 @@ public interface IAnalyticsClient GetTopHitsResponse GetTopHits(string index, string search = default, bool? clickAnalytics = default, bool? revenueAnalytics = default, string startDate = default, string endDate = default, int? limit = default, int? offset = default, string tags = default, RequestOptions options = null, CancellationToken cancellationToken = default); /// - /// 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 /// Index name. /// Whether to include metrics related to click and conversion events in the response. (optional, default to false) - /// Whether to include revenue-related metrics in the response. If true, metrics related to click and conversion events are also included in the response. (optional, default to false) + /// Whether to include metrics related to revenue events in the response. (optional, default to false) /// Start date of the period to analyze, in `YYYY-MM-DD` format. (optional) /// End date of the period to analyze, in `YYYY-MM-DD` format. (optional) /// Attribute by which to order the response items. If the `clickAnalytics` parameter is false, only `searchCount` is available. (optional) @@ -838,14 +838,14 @@ public interface IAnalyticsClient Task GetTopSearchesAsync(string index, bool? clickAnalytics = default, bool? revenueAnalytics = default, string startDate = default, string endDate = default, OrderBy? orderBy = default, Direction? direction = default, int? limit = default, int? offset = default, string tags = default, RequestOptions options = null, CancellationToken cancellationToken = default); /// - /// Returns the most popular search terms. (Synchronous version) + /// 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. (Synchronous version) /// /// /// Required API Key ACLs: /// - analytics /// Index name. /// Whether to include metrics related to click and conversion events in the response. (optional, default to false) - /// Whether to include revenue-related metrics in the response. If true, metrics related to click and conversion events are also included in the response. (optional, default to false) + /// Whether to include metrics related to revenue events in the response. (optional, default to false) /// Start date of the period to analyze, in `YYYY-MM-DD` format. (optional) /// End date of the period to analyze, in `YYYY-MM-DD` format. (optional) /// Attribute by which to order the response items. If the `clickAnalytics` parameter is false, only `searchCount` is available. (optional) @@ -862,7 +862,7 @@ public interface IAnalyticsClient GetTopSearchesResponse GetTopSearches(string index, bool? clickAnalytics = default, bool? revenueAnalytics = default, string startDate = default, string endDate = default, OrderBy? orderBy = default, Direction? direction = default, int? limit = default, int? offset = default, string tags = default, RequestOptions options = null, CancellationToken cancellationToken = default); /// - /// 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: @@ -880,7 +880,7 @@ public interface IAnalyticsClient Task GetUsersCountAsync(string index, string startDate = default, string endDate = default, string tags = default, RequestOptions options = null, CancellationToken cancellationToken = default); /// - /// 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. (Synchronous version) + /// 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. (Synchronous version) /// /// /// Required API Key ACLs: diff --git a/algoliasearch/Clients/AnalyticsConfiguration.cs b/algoliasearch/Clients/AnalyticsConfiguration.cs index fd75155c1..166c5461e 100644 --- a/algoliasearch/Clients/AnalyticsConfiguration.cs +++ b/algoliasearch/Clients/AnalyticsConfiguration.cs @@ -1,7 +1,7 @@ /* * Analytics API * -* The Analytics API gives you access to metrics related to your Algolia search experience. ## Base URLs The base URLs for requests to the Analytics API are: - `https://analytics.us.algolia.com` - `https://analytics.de.algolia.com` - `https://analytics.algolia.com` (routes requests to the closest of the above servers, based on your geographical location) Use the URL that matches your [analytics region](https://dashboard.algolia.com/account/infrastructure/analytics). **All requests must use HTTPS.** ## Availability and authentication Access to the Analytics API is available as part of the [Premium or Elevate plans](https://www.algolia.com/pricing). To authenticate your API requests, add these headers: - `x-algolia-application-id`. Your Algolia application ID. - `x-algolia-api-key`. An API key with the necessary permissions to make the request. The required access control list (ACL) to make a request is listed in each endpoint's reference. You can find your application ID and API key in the [Algolia dashboard](https://dashboard.algolia.com/account). ## Rate limits You can make up to **100 requests per minute per app** to the Analytics API. The response includes headers with information about the limits. ## Parameters Query parameters must be [URL-encoded](https://developer.mozilla.org/en-US/docs/Glossary/Percent-encoding). Non-ASCII characters must be UTF-8 encoded. Plus characters (`+`) are interpreted as spaces. ## Response status and errors The Analytics API returns JSON responses. Since JSON doesn't guarantee any specific ordering, don't rely on the order of attributes in the API response. Successful responses return a `2xx` status. Client errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a `message` property with more information. ## Version The current version of the Analytics API is version 2, as indicated by the `/2/` in each endpoint's URL. +* The Analytics API gives you access to metrics related to your Algolia search experience. ## Base URLs The base URLs for requests to the Analytics API are: - `https://analytics.us.algolia.com` - `https://analytics.de.algolia.com` - `https://analytics.algolia.com` (routes requests to the closest of the above servers, based on your geographical location) Use the URL that matches your [analytics region](https://dashboard.algolia.com/account/infrastructure/analytics). **All requests must use HTTPS.** ## Availability and authentication Access to the Analytics API is available as part of the [Premium or Elevate plans](https://www.algolia.com/pricing). To authenticate your API requests, add these headers: - `x-algolia-application-id`. Your Algolia application ID. - `x-algolia-api-key`. An API key with the necessary permissions to make the request. The required access control list (ACL) to make a request is listed in each endpoint's reference. You can find your application ID and API key in the [Algolia dashboard](https://dashboard.algolia.com/account). ## Rate limits You can make up to **100 requests per minute per app** to the Analytics API. The response includes headers with information about the limits. ## Parameters Query parameters must be [URL-encoded](https://developer.mozilla.org/en-US/docs/Glossary/Percent-encoding). Non-ASCII characters must be UTF-8 encoded. Plus characters (`+`) are interpreted as spaces. ## Response status and errors The Analytics API returns JSON responses. Since JSON doesn't guarantee any specific ordering, don't rely on the order of attributes in the API response. - Successful responses return a `2xx` status - Client errors return a `4xx` status - Server errors are indicated by a `5xx` status. Error responses have a `message` property with more information. ## Version The current version of the Analytics API is version 2, as indicated by the `/2/` in each endpoint's URL. ## Query aggregation Algolia accepts queries on each keystroke. To ensure you have relevant analytics data, however, the series of keystrokes is aggregated to keep only the latest (final) user query. This is called \"prefix\" aggregation. For more information, see [Query agggregation and processing](https://www.algolia.com/doc/guides/search-analytics/concepts/query-aggregation/). See the analytics implementation overview for more information about query aggregation. * * The version of the OpenAPI document: 2.0.0 * Generated by: https://github.com/openapitools/openapi-generator.git diff --git a/algoliasearch/Models/Analytics/DailyAddToCartRates.cs b/algoliasearch/Models/Analytics/DailyAddToCartRates.cs index 406dd3c5a..ba584965e 100644 --- a/algoliasearch/Models/Analytics/DailyAddToCartRates.cs +++ b/algoliasearch/Models/Analytics/DailyAddToCartRates.cs @@ -24,7 +24,7 @@ public DailyAddToCartRates() { } /// /// Initializes a new instance of the DailyAddToCartRates class. /// - /// 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. (required). + /// 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. (required). /// Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. (required) (default to 0). /// Number of add-to-cart events from this search. (required) (default to 0). /// Date in the format YYYY-MM-DD. (required). @@ -37,9 +37,9 @@ public DailyAddToCartRates(double? rate, int trackedSearchCount, int addToCartCo } /// - /// 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. /// - /// 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. [JsonPropertyName("rate")] public double? Rate { get; set; } diff --git a/algoliasearch/Models/Analytics/DailyClickThroughRates.cs b/algoliasearch/Models/Analytics/DailyClickThroughRates.cs index 91186409a..357895305 100644 --- a/algoliasearch/Models/Analytics/DailyClickThroughRates.cs +++ b/algoliasearch/Models/Analytics/DailyClickThroughRates.cs @@ -24,7 +24,7 @@ public DailyClickThroughRates() { } /// /// Initializes a new instance of the DailyClickThroughRates class. /// - /// 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. (required). + /// 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. (required). /// Number of clicks associated with this search. (required) (default to 0). /// Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. (required) (default to 0). /// Date in the format YYYY-MM-DD. (required). @@ -37,9 +37,9 @@ public DailyClickThroughRates(double? rate, int clickCount, int trackedSearchCou } /// - /// 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. /// - /// 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. [JsonPropertyName("rate")] public double? Rate { get; set; } diff --git a/algoliasearch/Models/Analytics/DailyConversionRates.cs b/algoliasearch/Models/Analytics/DailyConversionRates.cs index 9dc7278af..09b6dd956 100644 --- a/algoliasearch/Models/Analytics/DailyConversionRates.cs +++ b/algoliasearch/Models/Analytics/DailyConversionRates.cs @@ -24,7 +24,7 @@ public DailyConversionRates() { } /// /// Initializes a new instance of the DailyConversionRates class. /// - /// 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. (required). + /// 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. (required). /// Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. (required) (default to 0). /// Number of conversions from this search. (required) (default to 0). /// Date in the format YYYY-MM-DD. (required). @@ -37,9 +37,9 @@ public DailyConversionRates(double? rate, int trackedSearchCount, int conversion } /// - /// 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. /// - /// 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. [JsonPropertyName("rate")] public double? Rate { get; set; } diff --git a/algoliasearch/Models/Analytics/DailyNoClickRates.cs b/algoliasearch/Models/Analytics/DailyNoClickRates.cs index 9dbf156cc..b5f6964c8 100644 --- a/algoliasearch/Models/Analytics/DailyNoClickRates.cs +++ b/algoliasearch/Models/Analytics/DailyNoClickRates.cs @@ -24,7 +24,7 @@ public DailyNoClickRates() { } /// /// Initializes a new instance of the DailyNoClickRates class. /// - /// No click rate, calculated as number of tracked searches without any click divided by the number of tracked searches. (required). + /// No click rate: calculated as the number of tracked searches without clicks divided by the number of tracked searches. (required). /// Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. (required) (default to 0). /// Number of times this search was returned as a result without any click. (required). /// Date in the format YYYY-MM-DD. (required). @@ -37,9 +37,9 @@ public DailyNoClickRates(double rate, int count, int noClickCount, string date) } /// - /// 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. /// - /// 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. [JsonPropertyName("rate")] public double Rate { get; set; } diff --git a/algoliasearch/Models/Analytics/DailyNoResultsRates.cs b/algoliasearch/Models/Analytics/DailyNoResultsRates.cs index d3b8e0843..f621d948c 100644 --- a/algoliasearch/Models/Analytics/DailyNoResultsRates.cs +++ b/algoliasearch/Models/Analytics/DailyNoResultsRates.cs @@ -27,7 +27,7 @@ public DailyNoResultsRates() { } /// Date in the format YYYY-MM-DD. (required). /// Number of searches without any results. (required). /// Number of searches. (required). - /// No results rate, calculated as number of searches with zero results divided by the total number of searches. (required). + /// No results rate: calculated as the number of searches with zero results divided by the total number of searches. (required). public DailyNoResultsRates(string date, int noResultCount, int count, double rate) { Date = date ?? throw new ArgumentNullException(nameof(date)); @@ -58,9 +58,9 @@ public DailyNoResultsRates(string date, int noResultCount, int count, double rat public int Count { get; set; } /// - /// 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. /// - /// 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. [JsonPropertyName("rate")] public double Rate { get; set; } diff --git a/algoliasearch/Models/Analytics/DailyPurchaseRates.cs b/algoliasearch/Models/Analytics/DailyPurchaseRates.cs index cc7479cef..9e20f260c 100644 --- a/algoliasearch/Models/Analytics/DailyPurchaseRates.cs +++ b/algoliasearch/Models/Analytics/DailyPurchaseRates.cs @@ -24,7 +24,7 @@ public DailyPurchaseRates() { } /// /// Initializes a new instance of the DailyPurchaseRates class. /// - /// 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. (required). + /// 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. (required). /// Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. (required) (default to 0). /// Number of purchase events from this search. (required) (default to 0). /// Date in the format YYYY-MM-DD. (required). @@ -37,9 +37,9 @@ public DailyPurchaseRates(double? rate, int trackedSearchCount, int purchaseCoun } /// - /// 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. /// - /// 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. [JsonPropertyName("rate")] public double? Rate { get; set; } diff --git a/algoliasearch/Models/Analytics/DailyRevenue.cs b/algoliasearch/Models/Analytics/DailyRevenue.cs index 54a74d9fb..7d70f8466 100644 --- a/algoliasearch/Models/Analytics/DailyRevenue.cs +++ b/algoliasearch/Models/Analytics/DailyRevenue.cs @@ -24,7 +24,7 @@ public DailyRevenue() { } /// /// Initializes a new instance of the DailyRevenue class. /// - /// Revenue associated with this search, broken-down by currencies. (required). + /// Revenue associated with this search: broken down by currency. (required). /// Date in the format YYYY-MM-DD. (required). public DailyRevenue(Dictionary currencies, string date) { @@ -33,9 +33,9 @@ public DailyRevenue(Dictionary currencies, string date) } /// - /// Revenue associated with this search, broken-down by currencies. + /// Revenue associated with this search: broken down by currency. /// - /// Revenue associated with this search, broken-down by currencies. + /// Revenue associated with this search: broken down by currency. [JsonPropertyName("currencies")] public Dictionary Currencies { get; set; } diff --git a/algoliasearch/Models/Analytics/GetAddToCartRateResponse.cs b/algoliasearch/Models/Analytics/GetAddToCartRateResponse.cs index faf688b66..a8ba2d716 100644 --- a/algoliasearch/Models/Analytics/GetAddToCartRateResponse.cs +++ b/algoliasearch/Models/Analytics/GetAddToCartRateResponse.cs @@ -24,7 +24,7 @@ public GetAddToCartRateResponse() { } /// /// Initializes a new instance of the GetAddToCartRateResponse class. /// - /// 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. (required). + /// 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. (required). /// Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. (required) (default to 0). /// Number of add-to-cart events from this search. (required) (default to 0). /// Daily add-to-cart rates. (required). @@ -37,9 +37,9 @@ public GetAddToCartRateResponse(double? rate, int trackedSearchCount, int addToC } /// - /// 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. /// - /// 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. [JsonPropertyName("rate")] public double? Rate { get; set; } diff --git a/algoliasearch/Models/Analytics/GetClickThroughRateResponse.cs b/algoliasearch/Models/Analytics/GetClickThroughRateResponse.cs index ca3817919..c6bad0343 100644 --- a/algoliasearch/Models/Analytics/GetClickThroughRateResponse.cs +++ b/algoliasearch/Models/Analytics/GetClickThroughRateResponse.cs @@ -24,7 +24,7 @@ public GetClickThroughRateResponse() { } /// /// Initializes a new instance of the GetClickThroughRateResponse class. /// - /// 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. (required). + /// 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. (required). /// Number of clicks associated with this search. (required) (default to 0). /// Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. (required) (default to 0). /// Daily click-through rates. (required). @@ -37,9 +37,9 @@ public GetClickThroughRateResponse(double? rate, int clickCount, int trackedSear } /// - /// 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. /// - /// 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. [JsonPropertyName("rate")] public double? Rate { get; set; } diff --git a/algoliasearch/Models/Analytics/GetConversionRateResponse.cs b/algoliasearch/Models/Analytics/GetConversionRateResponse.cs index 43b25bf7a..f2a2b3e84 100644 --- a/algoliasearch/Models/Analytics/GetConversionRateResponse.cs +++ b/algoliasearch/Models/Analytics/GetConversionRateResponse.cs @@ -24,7 +24,7 @@ public GetConversionRateResponse() { } /// /// Initializes a new instance of the GetConversionRateResponse class. /// - /// 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. (required). + /// 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. (required). /// Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. (required) (default to 0). /// Number of conversions from this search. (required) (default to 0). /// Daily conversion rates. (required). @@ -37,9 +37,9 @@ public GetConversionRateResponse(double? rate, int trackedSearchCount, int conve } /// - /// 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. /// - /// 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. [JsonPropertyName("rate")] public double? Rate { get; set; } diff --git a/algoliasearch/Models/Analytics/GetNoClickRateResponse.cs b/algoliasearch/Models/Analytics/GetNoClickRateResponse.cs index 18c515b83..34f9af4ab 100644 --- a/algoliasearch/Models/Analytics/GetNoClickRateResponse.cs +++ b/algoliasearch/Models/Analytics/GetNoClickRateResponse.cs @@ -24,7 +24,7 @@ public GetNoClickRateResponse() { } /// /// Initializes a new instance of the GetNoClickRateResponse class. /// - /// No click rate, calculated as number of tracked searches without any click divided by the number of tracked searches. (required). + /// No click rate: calculated as the number of tracked searches without clicks divided by the number of tracked searches. (required). /// Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. (required) (default to 0). /// Number of times this search was returned as a result without any click. (required). /// Daily no click rates. (required). @@ -37,9 +37,9 @@ public GetNoClickRateResponse(double rate, int count, int noClickCount, List - /// 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. /// - /// 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. [JsonPropertyName("rate")] public double Rate { get; set; } diff --git a/algoliasearch/Models/Analytics/GetNoResultsRateResponse.cs b/algoliasearch/Models/Analytics/GetNoResultsRateResponse.cs index cde249dca..4908990ef 100644 --- a/algoliasearch/Models/Analytics/GetNoResultsRateResponse.cs +++ b/algoliasearch/Models/Analytics/GetNoResultsRateResponse.cs @@ -24,7 +24,7 @@ public GetNoResultsRateResponse() { } /// /// Initializes a new instance of the GetNoResultsRateResponse class. /// - /// No results rate, calculated as number of searches with zero results divided by the total number of searches. (required). + /// No results rate: calculated as the number of searches with zero results divided by the total number of searches. (required). /// Number of searches. (required). /// Number of searches without any results. (required). /// Daily no results rates. (required). @@ -37,9 +37,9 @@ public GetNoResultsRateResponse(double rate, int count, int noResultCount, List< } /// - /// 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. /// - /// 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. [JsonPropertyName("rate")] public double Rate { get; set; } diff --git a/algoliasearch/Models/Analytics/GetPurchaseRateResponse.cs b/algoliasearch/Models/Analytics/GetPurchaseRateResponse.cs index e25499868..bdd71f306 100644 --- a/algoliasearch/Models/Analytics/GetPurchaseRateResponse.cs +++ b/algoliasearch/Models/Analytics/GetPurchaseRateResponse.cs @@ -24,7 +24,7 @@ public GetPurchaseRateResponse() { } /// /// Initializes a new instance of the GetPurchaseRateResponse class. /// - /// 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. (required). + /// 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. (required). /// Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. (required) (default to 0). /// Number of purchase events from this search. (required) (default to 0). /// Daily purchase rates. (required). @@ -37,9 +37,9 @@ public GetPurchaseRateResponse(double? rate, int trackedSearchCount, int purchas } /// - /// 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. /// - /// 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. [JsonPropertyName("rate")] public double? Rate { get; set; } diff --git a/algoliasearch/Models/Analytics/GetRevenue.cs b/algoliasearch/Models/Analytics/GetRevenue.cs index d387e1443..335654ddf 100644 --- a/algoliasearch/Models/Analytics/GetRevenue.cs +++ b/algoliasearch/Models/Analytics/GetRevenue.cs @@ -24,7 +24,7 @@ public GetRevenue() { } /// /// Initializes a new instance of the GetRevenue class. /// - /// Revenue associated with this search, broken-down by currencies. (required). + /// Revenue associated with this search: broken down by currency. (required). /// Daily revenue. (required). public GetRevenue(Dictionary currencies, List dates) { @@ -33,9 +33,9 @@ public GetRevenue(Dictionary currencies, List - /// Revenue associated with this search, broken-down by currencies. + /// Revenue associated with this search: broken down by currency. /// - /// Revenue associated with this search, broken-down by currencies. + /// Revenue associated with this search: broken down by currency. [JsonPropertyName("currencies")] public Dictionary Currencies { get; set; } diff --git a/algoliasearch/Models/Analytics/GetTopFiltersNoResultsResponse.cs b/algoliasearch/Models/Analytics/GetTopFiltersNoResultsResponse.cs index 6b9a3a4c4..e653b36a5 100644 --- a/algoliasearch/Models/Analytics/GetTopFiltersNoResultsResponse.cs +++ b/algoliasearch/Models/Analytics/GetTopFiltersNoResultsResponse.cs @@ -24,16 +24,16 @@ public GetTopFiltersNoResultsResponse() { } /// /// Initializes a new instance of the GetTopFiltersNoResultsResponse class. /// - /// 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. (required). + /// 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. (required). public GetTopFiltersNoResultsResponse(List values) { Values = values ?? throw new ArgumentNullException(nameof(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. + /// 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. /// - /// 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. [JsonPropertyName("values")] public List Values { get; set; } diff --git a/algoliasearch/Models/Analytics/TopHit.cs b/algoliasearch/Models/Analytics/TopHit.cs index ebc617f8d..130543d2c 100644 --- a/algoliasearch/Models/Analytics/TopHit.cs +++ b/algoliasearch/Models/Analytics/TopHit.cs @@ -24,7 +24,7 @@ public TopHit() { } /// /// Initializes a new instance of the TopHit class. /// - /// Object ID of a record that's returned as a search result. (required). + /// Object ID of a record returned as a search result. (required). /// Number of occurrences. (required). public TopHit(string hit, int count) { @@ -33,9 +33,9 @@ public TopHit(string hit, int count) } /// - /// Object ID of a record that's returned as a search result. + /// Object ID of a record returned as a search result. /// - /// Object ID of a record that's returned as a search result. + /// Object ID of a record returned as a search result. [JsonPropertyName("hit")] public string Hit { get; set; } diff --git a/algoliasearch/Models/Analytics/TopHitWithAnalytics.cs b/algoliasearch/Models/Analytics/TopHitWithAnalytics.cs index 5591fc819..30cb5bb80 100644 --- a/algoliasearch/Models/Analytics/TopHitWithAnalytics.cs +++ b/algoliasearch/Models/Analytics/TopHitWithAnalytics.cs @@ -24,10 +24,10 @@ public TopHitWithAnalytics() { } /// /// Initializes a new instance of the TopHitWithAnalytics class. /// - /// Object ID of a record that's returned as a search result. (required). + /// Object ID of a record returned as a search result. (required). /// Number of occurrences. (required). - /// 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. (required). - /// 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. (required). + /// 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. (required). + /// 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. (required). /// Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. (required) (default to 0). /// Number of clicks associated with this search. (required) (default to 0). /// Number of conversions from this search. (required) (default to 0). @@ -43,9 +43,9 @@ public TopHitWithAnalytics(string hit, int count, double? clickThroughRate, doub } /// - /// Object ID of a record that's returned as a search result. + /// Object ID of a record returned as a search result. /// - /// Object ID of a record that's returned as a search result. + /// Object ID of a record returned as a search result. [JsonPropertyName("hit")] public string Hit { get; set; } @@ -57,16 +57,16 @@ public TopHitWithAnalytics(string hit, int count, double? clickThroughRate, doub public int Count { get; set; } /// - /// 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. /// - /// 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. [JsonPropertyName("clickThroughRate")] public double? ClickThroughRate { get; set; } /// - /// 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. /// - /// 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. [JsonPropertyName("conversionRate")] public double? ConversionRate { get; set; } diff --git a/algoliasearch/Models/Analytics/TopHitWithRevenueAnalytics.cs b/algoliasearch/Models/Analytics/TopHitWithRevenueAnalytics.cs index b4c64a67e..735c6a39a 100644 --- a/algoliasearch/Models/Analytics/TopHitWithRevenueAnalytics.cs +++ b/algoliasearch/Models/Analytics/TopHitWithRevenueAnalytics.cs @@ -24,18 +24,18 @@ public TopHitWithRevenueAnalytics() { } /// /// Initializes a new instance of the TopHitWithRevenueAnalytics class. /// - /// Object ID of a record that's returned as a search result. (required). + /// Object ID of a record returned as a search result. (required). /// Number of occurrences. (required). - /// 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. (required). - /// 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. (required). + /// 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. (required). + /// 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. (required). /// Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. (required) (default to 0). /// Number of clicks associated with this search. (required) (default to 0). /// Number of conversions from this search. (required) (default to 0). - /// 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. (required). + /// 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. (required). /// Number of add-to-cart events from this search. (required) (default to 0). - /// 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. (required). + /// 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. (required). /// Number of purchase events from this search. (required) (default to 0). - /// Revenue associated with this search, broken-down by currencies. (required). + /// Revenue associated with this search: broken down by currency. (required). public TopHitWithRevenueAnalytics(string hit, int count, double? clickThroughRate, double? conversionRate, int trackedHitCount, int clickCount, int conversionCount, double? addToCartRate, int addToCartCount, double? purchaseRate, int purchaseCount, Dictionary currencies) { Hit = hit ?? throw new ArgumentNullException(nameof(hit)); @@ -53,9 +53,9 @@ public TopHitWithRevenueAnalytics(string hit, int count, double? clickThroughRat } /// - /// Object ID of a record that's returned as a search result. + /// Object ID of a record returned as a search result. /// - /// Object ID of a record that's returned as a search result. + /// Object ID of a record returned as a search result. [JsonPropertyName("hit")] public string Hit { get; set; } @@ -67,16 +67,16 @@ public TopHitWithRevenueAnalytics(string hit, int count, double? clickThroughRat public int Count { get; set; } /// - /// 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. /// - /// 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. [JsonPropertyName("clickThroughRate")] public double? ClickThroughRate { get; set; } /// - /// 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. /// - /// 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. [JsonPropertyName("conversionRate")] public double? ConversionRate { get; set; } @@ -102,9 +102,9 @@ public TopHitWithRevenueAnalytics(string hit, int count, double? clickThroughRat public int ConversionCount { get; set; } /// - /// 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. /// - /// 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. [JsonPropertyName("addToCartRate")] public double? AddToCartRate { get; set; } @@ -116,9 +116,9 @@ public TopHitWithRevenueAnalytics(string hit, int count, double? clickThroughRat public int AddToCartCount { get; set; } /// - /// 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. /// - /// 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. [JsonPropertyName("purchaseRate")] public double? PurchaseRate { get; set; } @@ -130,9 +130,9 @@ public TopHitWithRevenueAnalytics(string hit, int count, double? clickThroughRat public int PurchaseCount { get; set; } /// - /// Revenue associated with this search, broken-down by currencies. + /// Revenue associated with this search: broken down by currency. /// - /// Revenue associated with this search, broken-down by currencies. + /// Revenue associated with this search: broken down by currency. [JsonPropertyName("currencies")] public Dictionary Currencies { get; set; } diff --git a/algoliasearch/Models/Analytics/TopSearchWithAnalytics.cs b/algoliasearch/Models/Analytics/TopSearchWithAnalytics.cs index 786dac941..f6e485916 100644 --- a/algoliasearch/Models/Analytics/TopSearchWithAnalytics.cs +++ b/algoliasearch/Models/Analytics/TopSearchWithAnalytics.cs @@ -26,10 +26,10 @@ public TopSearchWithAnalytics() { } /// /// Search query. (required). /// Number of searches. (required). - /// 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. (required). + /// 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. (required). /// 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. (required). /// List of positions in the search results and clicks associated with this search. (required). - /// 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. (required). + /// 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. (required). /// Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. (required) (default to 0). /// Number of clicks associated with this search. (required) (default to 0). /// Number of conversions from this search. (required) (default to 0). @@ -63,9 +63,9 @@ public TopSearchWithAnalytics(string search, int count, double? clickThroughRate public int Count { get; set; } /// - /// 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. /// - /// 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. [JsonPropertyName("clickThroughRate")] public double? ClickThroughRate { get; set; } @@ -84,9 +84,9 @@ public TopSearchWithAnalytics(string search, int count, double? clickThroughRate public List ClickPositions { get; set; } /// - /// 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. /// - /// 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. [JsonPropertyName("conversionRate")] public double? ConversionRate { get; set; } diff --git a/algoliasearch/Models/Analytics/TopSearchWithRevenueAnalytics.cs b/algoliasearch/Models/Analytics/TopSearchWithRevenueAnalytics.cs index fa9f7a26b..5428b5074 100644 --- a/algoliasearch/Models/Analytics/TopSearchWithRevenueAnalytics.cs +++ b/algoliasearch/Models/Analytics/TopSearchWithRevenueAnalytics.cs @@ -26,18 +26,18 @@ public TopSearchWithRevenueAnalytics() { } /// /// Search query. (required). /// Number of searches. (required). - /// 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. (required). + /// 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. (required). /// 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. (required). /// List of positions in the search results and clicks associated with this search. (required). - /// 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. (required). + /// 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. (required). /// Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. (required) (default to 0). /// Number of clicks associated with this search. (required) (default to 0). /// Number of conversions from this search. (required) (default to 0). /// Number of results (hits). (required). - /// Revenue associated with this search, broken-down by currencies. (required). - /// 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. (required). + /// Revenue associated with this search: broken down by currency. (required). + /// 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. (required). /// Number of add-to-cart events from this search. (required) (default to 0). - /// 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. (required). + /// 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. (required). /// Number of purchase events from this search. (required) (default to 0). public TopSearchWithRevenueAnalytics(string search, int count, double? clickThroughRate, double? averageClickPosition, List clickPositions, double? conversionRate, int trackedSearchCount, int clickCount, int conversionCount, int nbHits, Dictionary currencies, double? addToCartRate, int addToCartCount, double? purchaseRate, int purchaseCount) { @@ -73,9 +73,9 @@ public TopSearchWithRevenueAnalytics(string search, int count, double? clickThro public int Count { get; set; } /// - /// 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. /// - /// 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. [JsonPropertyName("clickThroughRate")] public double? ClickThroughRate { get; set; } @@ -94,9 +94,9 @@ public TopSearchWithRevenueAnalytics(string search, int count, double? clickThro public List ClickPositions { get; set; } /// - /// 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. /// - /// 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. [JsonPropertyName("conversionRate")] public double? ConversionRate { get; set; } @@ -129,16 +129,16 @@ public TopSearchWithRevenueAnalytics(string search, int count, double? clickThro public int NbHits { get; set; } /// - /// Revenue associated with this search, broken-down by currencies. + /// Revenue associated with this search: broken down by currency. /// - /// Revenue associated with this search, broken-down by currencies. + /// Revenue associated with this search: broken down by currency. [JsonPropertyName("currencies")] public Dictionary Currencies { get; set; } /// - /// 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. /// - /// 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. [JsonPropertyName("addToCartRate")] public double? AddToCartRate { get; set; } @@ -150,9 +150,9 @@ public TopSearchWithRevenueAnalytics(string search, int count, double? clickThro public int AddToCartCount { get; set; } /// - /// 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. /// - /// 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. [JsonPropertyName("purchaseRate")] public double? PurchaseRate { get; set; }