lib/algolia/api/analytics_client.rb in algolia-3.11.0 vs lib/algolia/api/analytics_client.rb in algolia-3.12.0

- old
+ new

@@ -1,5 +1,7 @@ +# frozen_string_literal: true + # Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT. module Algolia class AnalyticsClient attr_accessor :api_client @@ -37,11 +39,11 @@ raise "`region` must be one of the following: #{regions.join(", ")}" end hosts << Transport::StatefulHost.new( - region.nil? ? "analytics.algolia.com" : "analytics.{region}.algolia.com".sub!("{region}", region), + region.nil? ? "analytics.algolia.com" : "analytics.{region}.algolia.com".sub("{region}", region), accept: CallType::READ | CallType::WRITE ) config = Algolia::Configuration.new(app_id, api_key, hosts, "Analytics", opts) create_with_config(config) @@ -241,11 +243,11 @@ def custom_put(path, parameters = nil, body = nil, request_options = {}) response = custom_put_with_http_info(path, parameters, body, 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 # @param index [String] Index name. (required) # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. @@ -280,11 +282,11 @@ ) @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 # @param index [String] Index name. (required) # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. @@ -298,11 +300,11 @@ response.body, request_options[:debug_return_type] || "Analytics::GetAddToCartRateResponse" ) 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 # @param index [String] Index name. (required) # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. @@ -343,11 +345,11 @@ ) @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 # @param index [String] Index name. (required) # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. @@ -361,11 +363,11 @@ response.body, request_options[:debug_return_type] || "Analytics::GetAverageClickPositionResponse" ) 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 # @param index [String] Index name. (required) # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. @@ -400,11 +402,11 @@ ) @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 # @param index [String] Index name. (required) # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. @@ -418,11 +420,11 @@ response.body, request_options[:debug_return_type] || "Analytics::GetClickPositionsResponse" ) 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 # @param index [String] Index name. (required) # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. @@ -457,11 +459,11 @@ ) @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 # @param index [String] Index name. (required) # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. @@ -475,11 +477,11 @@ response.body, request_options[:debug_return_type] || "Analytics::GetClickThroughRateResponse" ) 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 # @param index [String] Index name. (required) # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. @@ -514,11 +516,11 @@ ) @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 # @param index [String] Index name. (required) # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. @@ -532,11 +534,11 @@ response.body, request_options[:debug_return_type] || "Analytics::GetConversionRateResponse" ) 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 # @param index [String] Index name. (required) # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. @@ -571,11 +573,11 @@ ) @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 # @param index [String] Index name. (required) # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. @@ -586,11 +588,11 @@ def get_no_click_rate(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) response = get_no_click_rate_with_http_info(index, start_date, end_date, tags, request_options) @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 # @param index [String] Index name. (required) # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. @@ -625,11 +627,11 @@ ) @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 # @param index [String] Index name. (required) # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. @@ -643,11 +645,11 @@ response.body, request_options[:debug_return_type] || "Analytics::GetNoResultsRateResponse" ) 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 # @param index [String] Index name. (required) # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. @@ -682,11 +684,11 @@ ) @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 # @param index [String] Index name. (required) # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. @@ -700,11 +702,11 @@ response.body, request_options[:debug_return_type] || "Analytics::GetPurchaseRateResponse" ) 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 # @param index [String] Index name. (required) # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. @@ -739,11 +741,11 @@ ) @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 # @param index [String] Index name. (required) # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. @@ -811,11 +813,11 @@ response.body, request_options[:debug_return_type] || "Analytics::GetSearchesCountResponse" ) 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 # @param index [String] Index name. (required) # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. @@ -862,11 +864,11 @@ ) @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 # @param index [String] Index name. (required) # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. @@ -898,11 +900,11 @@ response.body, request_options[:debug_return_type] || "Analytics::GetSearchesNoClicksResponse" ) 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 # @param index [String] Index name. (required) # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. @@ -949,11 +951,11 @@ ) @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 # @param index [String] Index name. (required) # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. @@ -985,11 +987,11 @@ response.body, request_options[:debug_return_type] || "Analytics::GetSearchesNoResultsResponse" ) 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&nbsp;minutes. # # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -1018,11 +1020,11 @@ ) @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&nbsp;minutes. # # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -1030,11 +1032,11 @@ def get_status(index, request_options = {}) response = get_status_with_http_info(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 # @param index [String] Index name. (required) # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. @@ -1081,11 +1083,11 @@ ) @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 # @param index [String] Index name. (required) # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. @@ -1109,11 +1111,11 @@ response.body, request_options[:debug_return_type] || "Analytics::GetTopCountriesResponse" ) 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 # @param index [String] Index name. (required) # @param search [String] Search query. @@ -1163,11 +1165,11 @@ ) @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 # @param index [String] Index name. (required) # @param search [String] Search query. @@ -1202,11 +1204,11 @@ response.body, request_options[:debug_return_type] || "Analytics::GetTopFilterAttributesResponse" ) 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 # @param attribute [String] Attribute name. (required) # @param index [String] Index name. (required) @@ -1262,11 +1264,11 @@ ) @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 # @param attribute [String] Attribute name. (required) # @param index [String] Index name. (required) @@ -1304,11 +1306,11 @@ response.body, request_options[:debug_return_type] || "Analytics::GetTopFilterForAttributeResponse" ) 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 # @param index [String] Index name. (required) # @param search [String] Search query. @@ -1358,11 +1360,11 @@ ) @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 # @param index [String] Index name. (required) # @param search [String] Search query. @@ -1397,18 +1399,18 @@ response.body, request_options[:debug_return_type] || "Analytics::GetTopFiltersNoResultsResponse" ) 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) # @param offset [Integer] Position of the first item to return. (default to 0) # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). @@ -1457,18 +1459,18 @@ ) @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) # @param offset [Integer] Position of the first item to return. (default to 0) # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). @@ -1499,17 +1501,17 @@ request_options ) @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') # @param direction [Direction] Sorting direction of the results: ascending or descending. (default to 'asc') # @param limit [Integer] Number of items to return. (default to 10) @@ -1562,17 +1564,17 @@ ) @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') # @param direction [Direction] Sorting direction of the results: ascending or descending. (default to 'asc') # @param limit [Integer] Number of items to return. (default to 10) @@ -1607,11 +1609,11 @@ request_options ) @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 # @param index [String] Index name. (required) # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. @@ -1646,10 +1648,10 @@ ) @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 # @param index [String] Index name. (required) # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.