From 44082c3a915a26b88f96885ec1399b54b8f73da0 Mon Sep 17 00:00:00 2001 From: algolia-bot Date: Thu, 16 Jan 2025 10:59:05 +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 --- lib/algolia/api/analytics_client.rb | 84 +++++++++---------- .../analytics/daily_add_to_cart_rates.rb | 2 +- .../analytics/daily_click_through_rates.rb | 2 +- .../analytics/daily_conversion_rates.rb | 2 +- .../models/analytics/daily_no_click_rates.rb | 2 +- .../analytics/daily_no_results_rates.rb | 2 +- .../models/analytics/daily_purchase_rates.rb | 2 +- lib/algolia/models/analytics/daily_revenue.rb | 2 +- .../get_add_to_cart_rate_response.rb | 2 +- .../get_click_through_rate_response.rb | 2 +- .../analytics/get_conversion_rate_response.rb | 2 +- .../analytics/get_no_click_rate_response.rb | 2 +- .../analytics/get_no_results_rate_response.rb | 2 +- .../analytics/get_purchase_rate_response.rb | 2 +- lib/algolia/models/analytics/get_revenue.rb | 2 +- .../get_top_filters_no_results_response.rb | 2 +- lib/algolia/models/analytics/top_hit.rb | 2 +- .../analytics/top_hit_with_analytics.rb | 6 +- .../top_hit_with_revenue_analytics.rb | 12 +-- .../analytics/top_search_with_analytics.rb | 4 +- .../top_search_with_revenue_analytics.rb | 10 +-- 21 files changed, 74 insertions(+), 74 deletions(-) diff --git a/lib/algolia/api/analytics_client.rb b/lib/algolia/api/analytics_client.rb index c92bc0ee..2f89166a 100644 --- a/lib/algolia/api/analytics_client.rb +++ b/lib/algolia/api/analytics_client.rb @@ -243,7 +243,7 @@ def custom_put(path, parameters = nil, body = nil, request_options = {}) @api_client.deserialize(response.body, request_options[:debug_return_type] || "Object") end - # Retrieves the add-to-cart rate for all of your searches with at least one add-to-cart event, including a daily breakdown. By default, the analyzed period includes the last eight days including the current day. + # Retrieves the add-to-cart rate for all your searches with at least one add-to-cart event, including a daily breakdown. By default, the analyzed period includes the last eight days including the current day. The rate is the number of add-to-cart conversion events divided by the number of tracked searches. A search is tracked if it returns a queryID (`clickAnalytics` is `true`). This differs from the response's `count`, which shows the overall number of searches, including those where `clickAnalytics` is `false`. **There's a difference between a 0 and null add-to-cart rate when `clickAnalytics` is enabled:** - **Null** means there were no queries: since Algolia didn't receive any events, the add-to-cart rate is null. - **0** mean there _were_ queries but no [add-to-cart events](https://www.algolia.com/doc/guides/sending-events/getting-started/) were received. # # Required API Key ACLs: # - analytics @@ -282,7 +282,7 @@ def get_add_to_cart_rate_with_http_info(index, start_date = nil, end_date = nil, @api_client.call_api(:GET, path, new_options) end - # Retrieves the add-to-cart rate for all of your searches with at least one add-to-cart event, including a daily breakdown. By default, the analyzed period includes the last eight days including the current day. + # Retrieves the add-to-cart rate for all your searches with at least one add-to-cart event, including a daily breakdown. By default, the analyzed period includes the last eight days including the current day. The rate is the number of add-to-cart conversion events divided by the number of tracked searches. A search is tracked if it returns a queryID (`clickAnalytics` is `true`). This differs from the response's `count`, which shows the overall number of searches, including those where `clickAnalytics` is `false`. **There's a difference between a 0 and null add-to-cart rate when `clickAnalytics` is enabled:** - **Null** means there were no queries: since Algolia didn't receive any events, the add-to-cart rate is null. - **0** mean there _were_ queries but no [add-to-cart events](https://www.algolia.com/doc/guides/sending-events/getting-started/) were received. # # Required API Key ACLs: # - analytics @@ -300,7 +300,7 @@ def get_add_to_cart_rate(index, start_date = nil, end_date = nil, tags = nil, re ) end - # Retrieves the average click position of your search results, including a daily breakdown. The average click position is the average of all clicked search results' positions. For example, if users only ever click on the first result for any search, the average click position is 1. By default, the analyzed period includes the last eight days including the current day. + # Retrieves the average click position of your search results, including a daily breakdown. The average click position is the average of all clicked search result positions. For example, if users only ever click on the first result for any search, the average click position is 1. By default, the analyzed period includes the last eight days including the current day. An average of `null` when `clickAnalytics` is enabled means Algolia didn't receive any [click events](https://www.algolia.com/doc/guides/sending-events/getting-started/) for the queries. The average is `null` until Algolia receives at least one click event. # # Required API Key ACLs: # - analytics @@ -345,7 +345,7 @@ def get_average_click_position_with_http_info( @api_client.call_api(:GET, path, new_options) end - # Retrieves the average click position of your search results, including a daily breakdown. The average click position is the average of all clicked search results' positions. For example, if users only ever click on the first result for any search, the average click position is 1. By default, the analyzed period includes the last eight days including the current day. + # Retrieves the average click position of your search results, including a daily breakdown. The average click position is the average of all clicked search result positions. For example, if users only ever click on the first result for any search, the average click position is 1. By default, the analyzed period includes the last eight days including the current day. An average of `null` when `clickAnalytics` is enabled means Algolia didn't receive any [click events](https://www.algolia.com/doc/guides/sending-events/getting-started/) for the queries. The average is `null` until Algolia receives at least one click event. # # Required API Key ACLs: # - analytics @@ -363,7 +363,7 @@ def get_average_click_position(index, start_date = nil, end_date = nil, tags = n ) end - # Retrieves the positions in the search results and their associated number of clicks. This lets you check how many clicks the first, second, or tenth search results receive. + # Retrieves the positions in the search results and their associated number of clicks. This lets you check how many clicks the first, second, or tenth search results receive. An average of `0` when `clickAnalytics` is enabled means Algolia didn't receive any [click events](https://www.algolia.com/doc/guides/sending-events/getting-started/) for the queries. # # Required API Key ACLs: # - analytics @@ -402,7 +402,7 @@ def get_click_positions_with_http_info(index, start_date = nil, end_date = nil, @api_client.call_api(:GET, path, new_options) end - # Retrieves the positions in the search results and their associated number of clicks. This lets you check how many clicks the first, second, or tenth search results receive. + # Retrieves the positions in the search results and their associated number of clicks. This lets you check how many clicks the first, second, or tenth search results receive. An average of `0` when `clickAnalytics` is enabled means Algolia didn't receive any [click events](https://www.algolia.com/doc/guides/sending-events/getting-started/) for the queries. # # Required API Key ACLs: # - analytics @@ -420,7 +420,7 @@ def get_click_positions(index, start_date = nil, end_date = nil, tags = nil, req ) end - # Retrieves the click-through rate for all of your searches with at least one click event, including a daily breakdown By default, the analyzed period includes the last eight days including the current day. + # Retrieves the click-through rate (CTR) for all your searches with at least one click event, including a daily breakdown. By default, the analyzed period includes the last eight days including the current day. **There's a difference between a 0 and null CTR when `clickAnalytics` is enabled:** - **Null** means there were no queries: since Algolia didn't receive any events, CTR is null. - **0** mean there _were_ queries but no [click events](https://www.algolia.com/doc/guides/sending-events/getting-started/) were received. # # Required API Key ACLs: # - analytics @@ -459,7 +459,7 @@ def get_click_through_rate_with_http_info(index, start_date = nil, end_date = ni @api_client.call_api(:GET, path, new_options) end - # Retrieves the click-through rate for all of your searches with at least one click event, including a daily breakdown By default, the analyzed period includes the last eight days including the current day. + # Retrieves the click-through rate (CTR) for all your searches with at least one click event, including a daily breakdown. By default, the analyzed period includes the last eight days including the current day. **There's a difference between a 0 and null CTR when `clickAnalytics` is enabled:** - **Null** means there were no queries: since Algolia didn't receive any events, CTR is null. - **0** mean there _were_ queries but no [click events](https://www.algolia.com/doc/guides/sending-events/getting-started/) were received. # # Required API Key ACLs: # - analytics @@ -477,7 +477,7 @@ def get_click_through_rate(index, start_date = nil, end_date = nil, tags = nil, ) end - # Retrieves the conversion rate for all of your searches with at least one conversion event, including a daily breakdown. By default, the analyzed period includes the last eight days including the current day. + # Retrieves the conversion rate (CR) for all your searches with at least one conversion event, including a daily breakdown. By default, the analyzed period includes the last eight days including the current day. **There's a difference between a 0 and null CR when `clickAnalytics` is enabled:** - **Null** means there were no queries: since Algolia didn't receive any events, CR is null. - **0** mean there _were_ queries but no [conversion events](https://www.algolia.com/doc/guides/sending-events/getting-started/) were received. # # Required API Key ACLs: # - analytics @@ -516,7 +516,7 @@ def get_conversion_rate_with_http_info(index, start_date = nil, end_date = nil, @api_client.call_api(:GET, path, new_options) end - # Retrieves the conversion rate for all of your searches with at least one conversion event, including a daily breakdown. By default, the analyzed period includes the last eight days including the current day. + # Retrieves the conversion rate (CR) for all your searches with at least one conversion event, including a daily breakdown. By default, the analyzed period includes the last eight days including the current day. **There's a difference between a 0 and null CR when `clickAnalytics` is enabled:** - **Null** means there were no queries: since Algolia didn't receive any events, CR is null. - **0** mean there _were_ queries but no [conversion events](https://www.algolia.com/doc/guides/sending-events/getting-started/) were received. # # Required API Key ACLs: # - analytics @@ -534,7 +534,7 @@ def get_conversion_rate(index, start_date = nil, end_date = nil, tags = nil, req ) end - # Retrieves the fraction of searches that didn't lead to any click within a time range, including a daily breakdown. By default, the analyzed period includes the last eight days including the current day. + # Retrieves the fraction of searches that didn't lead to any click within a time range, including a daily breakdown. It also returns the number of tracked searches and tracked searches without clicks. By default, the analyzed period includes the last eight days including the current day. # # Required API Key ACLs: # - analytics @@ -573,7 +573,7 @@ def get_no_click_rate_with_http_info(index, start_date = nil, end_date = nil, ta @api_client.call_api(:GET, path, new_options) end - # Retrieves the fraction of searches that didn't lead to any click within a time range, including a daily breakdown. By default, the analyzed period includes the last eight days including the current day. + # Retrieves the fraction of searches that didn't lead to any click within a time range, including a daily breakdown. It also returns the number of tracked searches and tracked searches without clicks. By default, the analyzed period includes the last eight days including the current day. # # Required API Key ACLs: # - analytics @@ -588,7 +588,7 @@ def get_no_click_rate(index, start_date = nil, end_date = nil, tags = nil, reque @api_client.deserialize(response.body, request_options[:debug_return_type] || "Analytics::GetNoClickRateResponse") end - # Retrieves the fraction of searches that didn't return any results within a time range, including a daily breakdown. By default, the analyzed period includes the last eight days including the current day. + # Retrieves the fraction of searches that didn't return any results within a time range, including a daily breakdown. It also returns the count of searches and searches without results used to compute the rates. By default, the analyzed period includes the last eight days including the current day. # # Required API Key ACLs: # - analytics @@ -627,7 +627,7 @@ def get_no_results_rate_with_http_info(index, start_date = nil, end_date = nil, @api_client.call_api(:GET, path, new_options) end - # Retrieves the fraction of searches that didn't return any results within a time range, including a daily breakdown. By default, the analyzed period includes the last eight days including the current day. + # Retrieves the fraction of searches that didn't return any results within a time range, including a daily breakdown. It also returns the count of searches and searches without results used to compute the rates. By default, the analyzed period includes the last eight days including the current day. # # Required API Key ACLs: # - analytics @@ -645,7 +645,7 @@ def get_no_results_rate(index, start_date = nil, end_date = nil, tags = nil, req ) end - # Retrieves the purchase rate for all of your searches with at least one purchase event, including a daily breakdown. By default, the analyzed period includes the last eight days including the current day. + # Retrieves the purchase rate for all your searches with at least one purchase event, including a daily breakdown. By default, the analyzed period includes the last eight days including the current day. The rate is the number of purchase conversion events divided by the number of tracked searches. A search is tracked if it returns a query ID (`clickAnalytics` is `true`). This differs from the response's `count`, which shows the overall number of searches, including those where `clickAnalytics` is `false`. **There's a difference between a 0 and null purchase rate when `clickAnalytics` is enabled:** - **Null** means there were no queries: since Algolia didn't receive any events, the purchase rate is null. - **0** mean there _were_ queries but no [purchase conversion events](https://www.algolia.com/doc/guides/sending-events/getting-started/) were received. # # Required API Key ACLs: # - analytics @@ -684,7 +684,7 @@ def get_purchase_rate_with_http_info(index, start_date = nil, end_date = nil, ta @api_client.call_api(:GET, path, new_options) end - # Retrieves the purchase rate for all of your searches with at least one purchase event, including a daily breakdown. By default, the analyzed period includes the last eight days including the current day. + # Retrieves the purchase rate for all your searches with at least one purchase event, including a daily breakdown. By default, the analyzed period includes the last eight days including the current day. The rate is the number of purchase conversion events divided by the number of tracked searches. A search is tracked if it returns a query ID (`clickAnalytics` is `true`). This differs from the response's `count`, which shows the overall number of searches, including those where `clickAnalytics` is `false`. **There's a difference between a 0 and null purchase rate when `clickAnalytics` is enabled:** - **Null** means there were no queries: since Algolia didn't receive any events, the purchase rate is null. - **0** mean there _were_ queries but no [purchase conversion events](https://www.algolia.com/doc/guides/sending-events/getting-started/) were received. # # Required API Key ACLs: # - analytics @@ -702,7 +702,7 @@ def get_purchase_rate(index, start_date = nil, end_date = nil, tags = nil, reque ) end - # Retrieves revenue-related metrics, such as the total revenue or the average order value. To retrieve revenue-related metrics, sent purchase events. By default, the analyzed period includes the last eight days including the current day. + # Retrieves revenue-related metrics, such as the total revenue or the average order value. To retrieve revenue-related metrics, send purchase events. By default, the analyzed period includes the last eight days including the current day. Revenue is based on purchase conversion events (a conversion event with an `eventSubtype` attribute of `purchase`). The revenue is the `price` attribute multiplied by the `quantity` attribute for each object in the event's `objectData` array. # # Required API Key ACLs: # - analytics @@ -741,7 +741,7 @@ def get_revenue_with_http_info(index, start_date = nil, end_date = nil, tags = n @api_client.call_api(:GET, path, new_options) end - # Retrieves revenue-related metrics, such as the total revenue or the average order value. To retrieve revenue-related metrics, sent purchase events. By default, the analyzed period includes the last eight days including the current day. + # Retrieves revenue-related metrics, such as the total revenue or the average order value. To retrieve revenue-related metrics, send purchase events. By default, the analyzed period includes the last eight days including the current day. Revenue is based on purchase conversion events (a conversion event with an `eventSubtype` attribute of `purchase`). The revenue is the `price` attribute multiplied by the `quantity` attribute for each object in the event's `objectData` array. # # Required API Key ACLs: # - analytics @@ -813,7 +813,7 @@ def get_searches_count(index, start_date = nil, end_date = nil, tags = nil, requ ) end - # Retrieves the most popular searches that didn't lead to any clicks, from the 1,000 most frequent searches. + # Retrieves the most popular searches that didn't lead to any clicks, from the 1,000 most frequent searches. For each search, it also returns the number of displayed search results that remained unclicked. # # Required API Key ACLs: # - analytics @@ -864,7 +864,7 @@ def get_searches_no_clicks_with_http_info( @api_client.call_api(:GET, path, new_options) end - # Retrieves the most popular searches that didn't lead to any clicks, from the 1,000 most frequent searches. + # Retrieves the most popular searches that didn't lead to any clicks, from the 1,000 most frequent searches. For each search, it also returns the number of displayed search results that remained unclicked. # # Required API Key ACLs: # - analytics @@ -900,7 +900,7 @@ def get_searches_no_clicks( ) end - # Retrieves the most popular searches that didn't return any results. + # Retrieves the 1,000 most frequent searches that produced zero results. # # Required API Key ACLs: # - analytics @@ -951,7 +951,7 @@ def get_searches_no_results_with_http_info( @api_client.call_api(:GET, path, new_options) end - # Retrieves the most popular searches that didn't return any results. + # Retrieves the 1,000 most frequent searches that produced zero results. # # Required API Key ACLs: # - analytics @@ -987,7 +987,7 @@ def get_searches_no_results( ) end - # Retrieves the time when the Analytics data for the specified index was last updated. The Analytics data is updated every 5 minutes. + # Retrieves the time when the Analytics data for the specified index was last updated. If the index has been recently created or no search has been performed yet the updated time is `null`. The Analytics data is updated every 5 minutes. # # Required API Key ACLs: # - analytics @@ -1020,7 +1020,7 @@ def get_status_with_http_info(index, request_options = {}) @api_client.call_api(:GET, path, new_options) end - # Retrieves the time when the Analytics data for the specified index was last updated. The Analytics data is updated every 5 minutes. + # Retrieves the time when the Analytics data for the specified index was last updated. If the index has been recently created or no search has been performed yet the updated time is `null`. The Analytics data is updated every 5 minutes. # # Required API Key ACLs: # - analytics @@ -1032,7 +1032,7 @@ def get_status(index, request_options = {}) @api_client.deserialize(response.body, request_options[:debug_return_type] || "Analytics::GetStatusResponse") end - # Retrieves the countries with the most searches to your index. + # Retrieves the countries with the most searches in your index. # # Required API Key ACLs: # - analytics @@ -1083,7 +1083,7 @@ def get_top_countries_with_http_info( @api_client.call_api(:GET, path, new_options) end - # Retrieves the countries with the most searches to your index. + # Retrieves the countries with the most searches in your index. # # Required API Key ACLs: # - analytics @@ -1111,7 +1111,7 @@ def get_top_countries( ) end - # Retrieves the most frequently used filter attributes. These are attributes of your records that you included in the `attributesForFaceting` setting. + # Retrieves the 1,000 most frequently used filter attributes. These are attributes of your records that you included in the `attributesForFaceting` setting. # # Required API Key ACLs: # - analytics @@ -1165,7 +1165,7 @@ def get_top_filter_attributes_with_http_info( @api_client.call_api(:GET, path, new_options) end - # Retrieves the most frequently used filter attributes. These are attributes of your records that you included in the `attributesForFaceting` setting. + # Retrieves the 1,000 most frequently used filter attributes. These are attributes of your records that you included in the `attributesForFaceting` setting. # # Required API Key ACLs: # - analytics @@ -1204,7 +1204,7 @@ def get_top_filter_attributes( ) end - # Retrieves the most frequent filter (facet) values for a filter attribute. These are attributes of your records that you included in the `attributesForFaceting` setting. + # Retrieves the 1,000 most frequent filter (facet) values for a filter attribute. These are attributes of your records that you included in the `attributesForFaceting` setting. # # Required API Key ACLs: # - analytics @@ -1264,7 +1264,7 @@ def get_top_filter_for_attribute_with_http_info( @api_client.call_api(:GET, path, new_options) end - # Retrieves the most frequent filter (facet) values for a filter attribute. These are attributes of your records that you included in the `attributesForFaceting` setting. + # Retrieves the 1,000 most frequent filter (facet) values for a filter attribute. These are attributes of your records that you included in the `attributesForFaceting` setting. # # Required API Key ACLs: # - analytics @@ -1306,7 +1306,7 @@ def get_top_filter_for_attribute( ) end - # Retrieves the most frequently used filters for a search that didn't return any results. To get the most frequent searches without results, use the [Retrieve searches without results](#tag/search/operation/getSearchesNoResults) operation. + # Retrieves the 1,000 most frequently used filters for a search that didn't return any results. To get the most frequent searches without results, use the [Retrieve searches without results](#tag/search/operation/getSearchesNoResults) operation. # # Required API Key ACLs: # - analytics @@ -1360,7 +1360,7 @@ def get_top_filters_no_results_with_http_info( @api_client.call_api(:GET, path, new_options) end - # Retrieves the most frequently used filters for a search that didn't return any results. To get the most frequent searches without results, use the [Retrieve searches without results](#tag/search/operation/getSearchesNoResults) operation. + # Retrieves the 1,000 most frequently used filters for a search that didn't return any results. To get the most frequent searches without results, use the [Retrieve searches without results](#tag/search/operation/getSearchesNoResults) operation. # # Required API Key ACLs: # - analytics @@ -1399,14 +1399,14 @@ def get_top_filters_no_results( ) end - # Retrieves the object IDs of the most frequent search results. + # Retrieves the object IDs of the 1,000 most frequent search results. If you set the `clickAnalytics` query parameter to true, the response also includes: - Tracked searches count. Tracked searches are Search API requests with the `clickAnalytics` parameter set to `true`. This differs from the response's `count`, which shows the overall number of searches, including those where `clickAnalytics` is `false`. - Click count - Click-through rate (CTR) - Conversion count - Conversion rate (CR) - Average click position If you set the `revenueAnalytics` parameter to `true`, the response also includes: - Add-to-cart count - Add-to-cart rate (ATCR) - Purchase count - Purchase rate - Revenue details for each currency **There's a difference between 0% rates and null rates:** - **Null** means there were no queries: since Algolia didn't receive any events, the rates (CTR, CR, ATCR, purchase rate) are null. - **0% rates** mean there _were_ queries but no [click or conversion events](https://www.algolia.com/doc/guides/sending-events/getting-started/) were received. # # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) # @param search [String] Search query. # @param click_analytics [Boolean] Whether to include metrics related to click and conversion events in the response. (default to false) - # @param revenue_analytics [Boolean] Whether to include revenue-related metrics in the response. If true, metrics related to click and conversion events are also included in the response. (default to false) + # @param revenue_analytics [Boolean] Whether to include metrics related to revenue events in the response. (default to false) # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. # @param limit [Integer] Number of items to return. (default to 10) @@ -1459,14 +1459,14 @@ def get_top_hits_with_http_info( @api_client.call_api(:GET, path, new_options) end - # Retrieves the object IDs of the most frequent search results. + # Retrieves the object IDs of the 1,000 most frequent search results. If you set the `clickAnalytics` query parameter to true, the response also includes: - Tracked searches count. Tracked searches are Search API requests with the `clickAnalytics` parameter set to `true`. This differs from the response's `count`, which shows the overall number of searches, including those where `clickAnalytics` is `false`. - Click count - Click-through rate (CTR) - Conversion count - Conversion rate (CR) - Average click position If you set the `revenueAnalytics` parameter to `true`, the response also includes: - Add-to-cart count - Add-to-cart rate (ATCR) - Purchase count - Purchase rate - Revenue details for each currency **There's a difference between 0% rates and null rates:** - **Null** means there were no queries: since Algolia didn't receive any events, the rates (CTR, CR, ATCR, purchase rate) are null. - **0% rates** mean there _were_ queries but no [click or conversion events](https://www.algolia.com/doc/guides/sending-events/getting-started/) were received. # # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) # @param search [String] Search query. # @param click_analytics [Boolean] Whether to include metrics related to click and conversion events in the response. (default to false) - # @param revenue_analytics [Boolean] Whether to include revenue-related metrics in the response. If true, metrics related to click and conversion events are also included in the response. (default to false) + # @param revenue_analytics [Boolean] Whether to include metrics related to revenue events in the response. (default to false) # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. # @param limit [Integer] Number of items to return. (default to 10) @@ -1501,13 +1501,13 @@ def get_top_hits( @api_client.deserialize(response.body, request_options[:debug_return_type] || "Analytics::GetTopHitsResponse") end - # Returns the most popular search terms. + # Returns the most popular searches. For each search, it also includes the average number of hits. If you set the `clickAnalytics` query parameter to `true`, the response also includes - Tracked searches count. Tracked searches are Search API requests with the `clickAnalytics` parameter set to `true`. This differs from the response's `count`, which shows the overall number of searches, including those where `clickAnalytics` is `false`. - Click count - Click-through rate (CTR) - Conversion count - Conversion rate (CR) - Average click position If you set the `revenueAnalytics` query parameter to `true`, the response also includes: - Add-to-cart count - Add-to-cart rate (ATCR) - Purchase count - Purchase rate - Revenue details for each currency **There's a difference between 0% rates and null rates:** - **Null** means there were no queries: since Algolia didn't receive any events, the rates (CTR, CR, ATCR, purchase rate) are null. - **0% rates** mean there _were_ queries but no [click or conversion events](https://www.algolia.com/doc/guides/sending-events/getting-started/) were received. # # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) # @param click_analytics [Boolean] Whether to include metrics related to click and conversion events in the response. (default to false) - # @param revenue_analytics [Boolean] Whether to include revenue-related metrics in the response. If true, metrics related to click and conversion events are also included in the response. (default to false) + # @param revenue_analytics [Boolean] Whether to include metrics related to revenue events in the response. (default to false) # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. # @param order_by [OrderBy] Attribute by which to order the response items. If the `clickAnalytics` parameter is false, only `searchCount` is available. (default to 'searchCount') @@ -1564,13 +1564,13 @@ def get_top_searches_with_http_info( @api_client.call_api(:GET, path, new_options) end - # Returns the most popular search terms. + # Returns the most popular searches. For each search, it also includes the average number of hits. If you set the `clickAnalytics` query parameter to `true`, the response also includes - Tracked searches count. Tracked searches are Search API requests with the `clickAnalytics` parameter set to `true`. This differs from the response's `count`, which shows the overall number of searches, including those where `clickAnalytics` is `false`. - Click count - Click-through rate (CTR) - Conversion count - Conversion rate (CR) - Average click position If you set the `revenueAnalytics` query parameter to `true`, the response also includes: - Add-to-cart count - Add-to-cart rate (ATCR) - Purchase count - Purchase rate - Revenue details for each currency **There's a difference between 0% rates and null rates:** - **Null** means there were no queries: since Algolia didn't receive any events, the rates (CTR, CR, ATCR, purchase rate) are null. - **0% rates** mean there _were_ queries but no [click or conversion events](https://www.algolia.com/doc/guides/sending-events/getting-started/) were received. # # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) # @param click_analytics [Boolean] Whether to include metrics related to click and conversion events in the response. (default to false) - # @param revenue_analytics [Boolean] Whether to include revenue-related metrics in the response. If true, metrics related to click and conversion events are also included in the response. (default to false) + # @param revenue_analytics [Boolean] Whether to include metrics related to revenue events in the response. (default to false) # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. # @param order_by [OrderBy] Attribute by which to order the response items. If the `clickAnalytics` parameter is false, only `searchCount` is available. (default to 'searchCount') @@ -1609,7 +1609,7 @@ def get_top_searches( @api_client.deserialize(response.body, request_options[:debug_return_type] || "Analytics::GetTopSearchesResponse") end - # Retrieves the number of unique users within a time range, including a daily breakdown. Since this endpoint returns the number of unique users, the sum of the daily values might be different from the total number. By default, Algolia distinguishes search users by their IP address, _unless_ you include a pseudonymous user identifier in your search requests with the `userToken` API parameter or `x-algolia-usertoken` request header. By default, the analyzed period includes the last eight days including the current day. + # Retrieves the number of unique users within a time range, including a daily breakdown. Since it returns the number of unique users, the sum of the daily values might be different from the total number. By default: - Algolia distinguishes search users by their IP address, _unless_ you include a pseudonymous user identifier in your search requests with the `userToken` API parameter or `x-algolia-usertoken` request header. - The analyzed period includes the last eight days including the current day. # # Required API Key ACLs: # - analytics @@ -1648,7 +1648,7 @@ def get_users_count_with_http_info(index, start_date = nil, end_date = nil, tags @api_client.call_api(:GET, path, new_options) end - # Retrieves the number of unique users within a time range, including a daily breakdown. Since this endpoint returns the number of unique users, the sum of the daily values might be different from the total number. By default, Algolia distinguishes search users by their IP address, _unless_ you include a pseudonymous user identifier in your search requests with the `userToken` API parameter or `x-algolia-usertoken` request header. By default, the analyzed period includes the last eight days including the current day. + # Retrieves the number of unique users within a time range, including a daily breakdown. Since it returns the number of unique users, the sum of the daily values might be different from the total number. By default: - Algolia distinguishes search users by their IP address, _unless_ you include a pseudonymous user identifier in your search requests with the `userToken` API parameter or `x-algolia-usertoken` request header. - The analyzed period includes the last eight days including the current day. # # Required API Key ACLs: # - analytics diff --git a/lib/algolia/models/analytics/daily_add_to_cart_rates.rb b/lib/algolia/models/analytics/daily_add_to_cart_rates.rb index 59f2c9da..34c3fd96 100644 --- a/lib/algolia/models/analytics/daily_add_to_cart_rates.rb +++ b/lib/algolia/models/analytics/daily_add_to_cart_rates.rb @@ -6,7 +6,7 @@ module Algolia module Analytics class DailyAddToCartRates - # Add-to-cart rate, calculated as number of tracked searches with at least one add-to-cart event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true. + # Add-to-cart rate: calculated as the number of tracked searches with at least one add-to-cart event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true. attr_accessor :rate # Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. diff --git a/lib/algolia/models/analytics/daily_click_through_rates.rb b/lib/algolia/models/analytics/daily_click_through_rates.rb index 9f03871b..b5959650 100644 --- a/lib/algolia/models/analytics/daily_click_through_rates.rb +++ b/lib/algolia/models/analytics/daily_click_through_rates.rb @@ -6,7 +6,7 @@ module Algolia module Analytics class DailyClickThroughRates - # Click-through rate, calculated as number of tracked searches with at least one click event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true. + # Click-through rate: calculated as the number of tracked searches with at least one click event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true. attr_accessor :rate # Number of clicks associated with this search. diff --git a/lib/algolia/models/analytics/daily_conversion_rates.rb b/lib/algolia/models/analytics/daily_conversion_rates.rb index 25cec28d..170a5a54 100644 --- a/lib/algolia/models/analytics/daily_conversion_rates.rb +++ b/lib/algolia/models/analytics/daily_conversion_rates.rb @@ -6,7 +6,7 @@ module Algolia module Analytics class DailyConversionRates - # Conversion rate, calculated as number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true. + # Conversion rate: calculated as the number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true. attr_accessor :rate # Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. diff --git a/lib/algolia/models/analytics/daily_no_click_rates.rb b/lib/algolia/models/analytics/daily_no_click_rates.rb index 3f8efa56..a01127c1 100644 --- a/lib/algolia/models/analytics/daily_no_click_rates.rb +++ b/lib/algolia/models/analytics/daily_no_click_rates.rb @@ -6,7 +6,7 @@ module Algolia module Analytics class DailyNoClickRates - # No click rate, calculated as number of tracked searches without any click divided by the number of tracked searches. + # No click rate: calculated as the number of tracked searches without clicks divided by the number of tracked searches. attr_accessor :rate # Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. diff --git a/lib/algolia/models/analytics/daily_no_results_rates.rb b/lib/algolia/models/analytics/daily_no_results_rates.rb index c3302593..25243d03 100644 --- a/lib/algolia/models/analytics/daily_no_results_rates.rb +++ b/lib/algolia/models/analytics/daily_no_results_rates.rb @@ -15,7 +15,7 @@ class DailyNoResultsRates # Number of searches. attr_accessor :count - # 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. attr_accessor :rate # Attribute mapping from ruby-style variable name to JSON key. diff --git a/lib/algolia/models/analytics/daily_purchase_rates.rb b/lib/algolia/models/analytics/daily_purchase_rates.rb index 2602b503..d8a930a0 100644 --- a/lib/algolia/models/analytics/daily_purchase_rates.rb +++ b/lib/algolia/models/analytics/daily_purchase_rates.rb @@ -6,7 +6,7 @@ module Algolia module Analytics class DailyPurchaseRates - # Purchase rate, calculated as number of tracked searches with at least one purchase event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true. + # Purchase rate: calculated as the number of tracked searches with at least one purchase event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true. attr_accessor :rate # Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. diff --git a/lib/algolia/models/analytics/daily_revenue.rb b/lib/algolia/models/analytics/daily_revenue.rb index 4d407726..83b3bfd9 100644 --- a/lib/algolia/models/analytics/daily_revenue.rb +++ b/lib/algolia/models/analytics/daily_revenue.rb @@ -6,7 +6,7 @@ module Algolia module Analytics class DailyRevenue - # Revenue associated with this search, broken-down by currencies. + # Revenue associated with this search: broken down by currency. attr_accessor :currencies # Date in the format YYYY-MM-DD. diff --git a/lib/algolia/models/analytics/get_add_to_cart_rate_response.rb b/lib/algolia/models/analytics/get_add_to_cart_rate_response.rb index 419a7a23..295361b0 100644 --- a/lib/algolia/models/analytics/get_add_to_cart_rate_response.rb +++ b/lib/algolia/models/analytics/get_add_to_cart_rate_response.rb @@ -6,7 +6,7 @@ module Algolia module Analytics class GetAddToCartRateResponse - # Add-to-cart rate, calculated as number of tracked searches with at least one add-to-cart event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true. + # Add-to-cart rate: calculated as the number of tracked searches with at least one add-to-cart event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true. attr_accessor :rate # Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. diff --git a/lib/algolia/models/analytics/get_click_through_rate_response.rb b/lib/algolia/models/analytics/get_click_through_rate_response.rb index e6470fd1..906ebc64 100644 --- a/lib/algolia/models/analytics/get_click_through_rate_response.rb +++ b/lib/algolia/models/analytics/get_click_through_rate_response.rb @@ -6,7 +6,7 @@ module Algolia module Analytics class GetClickThroughRateResponse - # Click-through rate, calculated as number of tracked searches with at least one click event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true. + # Click-through rate: calculated as the number of tracked searches with at least one click event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true. attr_accessor :rate # Number of clicks associated with this search. diff --git a/lib/algolia/models/analytics/get_conversion_rate_response.rb b/lib/algolia/models/analytics/get_conversion_rate_response.rb index 7f3c5a80..701bfb3a 100644 --- a/lib/algolia/models/analytics/get_conversion_rate_response.rb +++ b/lib/algolia/models/analytics/get_conversion_rate_response.rb @@ -6,7 +6,7 @@ module Algolia module Analytics class GetConversionRateResponse - # Conversion rate, calculated as number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true. + # Conversion rate: calculated as the number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true. attr_accessor :rate # Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. diff --git a/lib/algolia/models/analytics/get_no_click_rate_response.rb b/lib/algolia/models/analytics/get_no_click_rate_response.rb index 23459f97..07c92d82 100644 --- a/lib/algolia/models/analytics/get_no_click_rate_response.rb +++ b/lib/algolia/models/analytics/get_no_click_rate_response.rb @@ -6,7 +6,7 @@ module Algolia module Analytics class GetNoClickRateResponse - # No click rate, calculated as number of tracked searches without any click divided by the number of tracked searches. + # No click rate: calculated as the number of tracked searches without clicks divided by the number of tracked searches. attr_accessor :rate # Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. diff --git a/lib/algolia/models/analytics/get_no_results_rate_response.rb b/lib/algolia/models/analytics/get_no_results_rate_response.rb index b7b324a4..7a659125 100644 --- a/lib/algolia/models/analytics/get_no_results_rate_response.rb +++ b/lib/algolia/models/analytics/get_no_results_rate_response.rb @@ -6,7 +6,7 @@ module Algolia module Analytics class GetNoResultsRateResponse - # No results rate, calculated as number of searches with zero results divided by the total number of searches. + # No results rate: calculated as the number of searches with zero results divided by the total number of searches. attr_accessor :rate # Number of searches. diff --git a/lib/algolia/models/analytics/get_purchase_rate_response.rb b/lib/algolia/models/analytics/get_purchase_rate_response.rb index 03aae4a2..cce1f88c 100644 --- a/lib/algolia/models/analytics/get_purchase_rate_response.rb +++ b/lib/algolia/models/analytics/get_purchase_rate_response.rb @@ -6,7 +6,7 @@ module Algolia module Analytics class GetPurchaseRateResponse - # Purchase rate, calculated as number of tracked searches with at least one purchase event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true. + # Purchase rate: calculated as the number of tracked searches with at least one purchase event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true. attr_accessor :rate # Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. diff --git a/lib/algolia/models/analytics/get_revenue.rb b/lib/algolia/models/analytics/get_revenue.rb index 666b5052..916f4c54 100644 --- a/lib/algolia/models/analytics/get_revenue.rb +++ b/lib/algolia/models/analytics/get_revenue.rb @@ -6,7 +6,7 @@ module Algolia module Analytics class GetRevenue - # Revenue associated with this search, broken-down by currencies. + # Revenue associated with this search: broken down by currency. attr_accessor :currencies # Daily revenue. diff --git a/lib/algolia/models/analytics/get_top_filters_no_results_response.rb b/lib/algolia/models/analytics/get_top_filters_no_results_response.rb index e7c2c74d..d048852f 100644 --- a/lib/algolia/models/analytics/get_top_filters_no_results_response.rb +++ b/lib/algolia/models/analytics/get_top_filters_no_results_response.rb @@ -6,7 +6,7 @@ module Algolia module Analytics class GetTopFiltersNoResultsResponse - # Filters for searches without any results. If null, the search term specified with the `search` parameter is not a search without results, or the `search` parameter is absent from the request. + # Filters for searches without any results. If null, the search term specified with the `search` parameter isn't a search without results, or the `search` parameter is absent from the request. attr_accessor :values # Attribute mapping from ruby-style variable name to JSON key. diff --git a/lib/algolia/models/analytics/top_hit.rb b/lib/algolia/models/analytics/top_hit.rb index 064d8bd8..4376f58e 100644 --- a/lib/algolia/models/analytics/top_hit.rb +++ b/lib/algolia/models/analytics/top_hit.rb @@ -6,7 +6,7 @@ module Algolia module Analytics class TopHit - # Object ID of a record that's returned as a search result. + # Object ID of a record returned as a search result. attr_accessor :hit # Number of occurrences. diff --git a/lib/algolia/models/analytics/top_hit_with_analytics.rb b/lib/algolia/models/analytics/top_hit_with_analytics.rb index f74a088b..a150117d 100644 --- a/lib/algolia/models/analytics/top_hit_with_analytics.rb +++ b/lib/algolia/models/analytics/top_hit_with_analytics.rb @@ -6,16 +6,16 @@ module Algolia module Analytics class TopHitWithAnalytics - # Object ID of a record that's returned as a search result. + # Object ID of a record returned as a search result. attr_accessor :hit # Number of occurrences. attr_accessor :count - # 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. attr_accessor :click_through_rate - # Conversion rate, calculated as number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true. + # 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. attr_accessor :conversion_rate # Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. diff --git a/lib/algolia/models/analytics/top_hit_with_revenue_analytics.rb b/lib/algolia/models/analytics/top_hit_with_revenue_analytics.rb index bdad4255..db5f3c93 100644 --- a/lib/algolia/models/analytics/top_hit_with_revenue_analytics.rb +++ b/lib/algolia/models/analytics/top_hit_with_revenue_analytics.rb @@ -6,16 +6,16 @@ module Algolia module Analytics class TopHitWithRevenueAnalytics - # Object ID of a record that's returned as a search result. + # Object ID of a record returned as a search result. attr_accessor :hit # Number of occurrences. attr_accessor :count - # 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. attr_accessor :click_through_rate - # Conversion rate, calculated as number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true. + # 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. attr_accessor :conversion_rate # Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. @@ -27,19 +27,19 @@ class TopHitWithRevenueAnalytics # Number of conversions from this search. attr_accessor :conversion_count - # 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. attr_accessor :add_to_cart_rate # Number of add-to-cart events from this search. attr_accessor :add_to_cart_count - # 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. attr_accessor :purchase_rate # Number of purchase events from this search. attr_accessor :purchase_count - # Revenue associated with this search, broken-down by currencies. + # Revenue associated with this search: broken down by currency. attr_accessor :currencies # Attribute mapping from ruby-style variable name to JSON key. diff --git a/lib/algolia/models/analytics/top_search_with_analytics.rb b/lib/algolia/models/analytics/top_search_with_analytics.rb index 37a65a6b..970d16c9 100644 --- a/lib/algolia/models/analytics/top_search_with_analytics.rb +++ b/lib/algolia/models/analytics/top_search_with_analytics.rb @@ -12,7 +12,7 @@ class TopSearchWithAnalytics # Number of searches. attr_accessor :count - # 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. attr_accessor :click_through_rate # 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. @@ -21,7 +21,7 @@ class TopSearchWithAnalytics # List of positions in the search results and clicks associated with this search. attr_accessor :click_positions - # 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. attr_accessor :conversion_rate # Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. diff --git a/lib/algolia/models/analytics/top_search_with_revenue_analytics.rb b/lib/algolia/models/analytics/top_search_with_revenue_analytics.rb index 1aa9f470..d78149ab 100644 --- a/lib/algolia/models/analytics/top_search_with_revenue_analytics.rb +++ b/lib/algolia/models/analytics/top_search_with_revenue_analytics.rb @@ -12,7 +12,7 @@ class TopSearchWithRevenueAnalytics # Number of searches. attr_accessor :count - # 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. attr_accessor :click_through_rate # 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. @@ -21,7 +21,7 @@ class TopSearchWithRevenueAnalytics # List of positions in the search results and clicks associated with this search. attr_accessor :click_positions - # 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. attr_accessor :conversion_rate # Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. @@ -36,16 +36,16 @@ class TopSearchWithRevenueAnalytics # Number of results (hits). attr_accessor :nb_hits - # Revenue associated with this search, broken-down by currencies. + # Revenue associated with this search: broken down by currency. attr_accessor :currencies - # 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. attr_accessor :add_to_cart_rate # Number of add-to-cart events from this search. attr_accessor :add_to_cart_count - # 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. attr_accessor :purchase_rate # Number of purchase events from this search.