diff --git a/algolia/analytics/api_analytics.go b/algolia/analytics/api_analytics.go index a3a479e18..8c529a38f 100644 --- a/algolia/analytics/api_analytics.go +++ b/algolia/analytics/api_analytics.go @@ -718,10 +718,19 @@ func (r ApiGetAddToCartRateRequest) WithTags(tags string) ApiGetAddToCartRateReq /* GetAddToCartRate calls the API and returns the raw response from it. - Retrieves the add-to-cart rate for all of your searches with at least one add-to-cart event, including a daily breakdown. + 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 @@ -777,10 +786,19 @@ func (c *APIClient) GetAddToCartRateWithHTTPInfo(r ApiGetAddToCartRateRequest, o /* GetAddToCartRate casts the HTTP response body to a defined struct. -Retrieves the add-to-cart rate for all of your searches with at least one add-to-cart event, including a daily breakdown. +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 @@ -899,10 +917,13 @@ GetAverageClickPosition calls the API and returns the raw response from it. 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. +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 @@ -960,10 +981,13 @@ GetAverageClickPosition casts the HTTP response body to a defined struct. 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. +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 @@ -1084,6 +1108,8 @@ GetClickPositions calls the API and returns the raw response from it. 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 @@ -1143,6 +1169,8 @@ Retrieves the positions in the search results and their associated number of cli 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 @@ -1259,10 +1287,15 @@ func (r ApiGetClickThroughRateRequest) WithTags(tags string) ApiGetClickThroughR /* GetClickThroughRate calls the API and returns the raw response from it. - Retrieves the click-through rate for all of your searches with at least one click event, including a daily breakdown + 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 @@ -1318,10 +1351,15 @@ func (c *APIClient) GetClickThroughRateWithHTTPInfo(r ApiGetClickThroughRateRequ /* GetClickThroughRate casts the HTTP response body to a defined struct. -# Retrieves the click-through rate for all of your searches with at least one click event, including a daily breakdown +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 @@ -1438,10 +1476,15 @@ func (r ApiGetConversionRateRequest) WithTags(tags string) ApiGetConversionRateR /* GetConversionRate calls the API and returns the raw response from it. - Retrieves the conversion rate for all of your searches with at least one conversion event, including a daily breakdown. + 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 @@ -1497,10 +1540,15 @@ func (c *APIClient) GetConversionRateWithHTTPInfo(r ApiGetConversionRateRequest, /* GetConversionRate casts the HTTP response body to a defined struct. -Retrieves the conversion rate for all of your searches with at least one conversion event, including a daily breakdown. +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 @@ -1619,6 +1667,8 @@ GetNoClickRate calls the API and returns the raw response from it. 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: @@ -1677,6 +1727,7 @@ func (c *APIClient) GetNoClickRateWithHTTPInfo(r ApiGetNoClickRateRequest, opts GetNoClickRate casts the HTTP response body to a defined struct. 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. @@ -1798,6 +1849,8 @@ GetNoResultsRate calls the API and returns the raw response from it. 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: @@ -1856,6 +1909,7 @@ func (c *APIClient) GetNoResultsRateWithHTTPInfo(r ApiGetNoResultsRateRequest, o GetNoResultsRate casts the HTTP response body to a defined struct. 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. @@ -1975,10 +2029,19 @@ func (r ApiGetPurchaseRateRequest) WithTags(tags string) ApiGetPurchaseRateReque /* GetPurchaseRate calls the API and returns the raw response from it. - Retrieves the purchase rate for all of your searches with at least one purchase event, including a daily breakdown. + 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 @@ -2034,10 +2097,19 @@ func (c *APIClient) GetPurchaseRateWithHTTPInfo(r ApiGetPurchaseRateRequest, opt /* GetPurchaseRate casts the HTTP response body to a defined struct. -Retrieves the purchase rate for all of your searches with at least one purchase event, including a daily breakdown. +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 @@ -2156,9 +2228,12 @@ GetRevenue calls the API and returns the raw response from it. Retrieves revenue-related metrics, such as the total revenue or the average order value. -To retrieve revenue-related metrics, sent purchase events. +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 @@ -2216,9 +2291,12 @@ GetRevenue casts the HTTP response body to a defined struct. Retrieves revenue-related metrics, such as the total revenue or the average order value. -To retrieve revenue-related metrics, sent purchase events. +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 @@ -2546,7 +2624,9 @@ func (r ApiGetSearchesNoClicksRequest) WithTags(tags string) ApiGetSearchesNoCli /* GetSearchesNoClicks calls the API and returns the raw response from it. - 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 @@ -2613,6 +2693,8 @@ GetSearchesNoClicks casts the HTTP response body to a defined struct. 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 @@ -2763,7 +2845,7 @@ func (r ApiGetSearchesNoResultsRequest) WithTags(tags string) ApiGetSearchesNoRe /* GetSearchesNoResults calls the API and returns the raw response from it. - 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 @@ -2828,7 +2910,7 @@ func (c *APIClient) GetSearchesNoResultsWithHTTPInfo(r ApiGetSearchesNoResultsRe /* GetSearchesNoResults casts the HTTP response body to a defined struct. -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 @@ -2902,7 +2984,9 @@ GetStatus calls the API and returns the raw response from it. Retrieves the time when the Analytics data for the specified index was last updated. -The Analytics data is updated every 5 minutes. +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 @@ -2949,7 +3033,9 @@ GetStatus casts the HTTP response body to a defined struct. Retrieves the time when the Analytics data for the specified index was last updated. -The Analytics data is updated every 5 minutes. +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 @@ -3096,7 +3182,7 @@ func (r ApiGetTopCountriesRequest) WithTags(tags string) ApiGetTopCountriesReque /* GetTopCountries calls the API and returns the raw response from it. - 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 @@ -3161,7 +3247,7 @@ func (c *APIClient) GetTopCountriesWithHTTPInfo(r ApiGetTopCountriesRequest, opt /* GetTopCountries casts the HTTP response body to a defined struct. -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 @@ -3329,7 +3415,7 @@ func (r ApiGetTopFilterAttributesRequest) WithTags(tags string) ApiGetTopFilterA /* GetTopFilterAttributes calls the API and returns the raw response from it. - Retrieves the most frequently used filter attributes. + Retrieves the 1,000 most frequently used filter attributes. These are attributes of your records that you included in the `attributesForFaceting` setting. @@ -3400,7 +3486,7 @@ func (c *APIClient) GetTopFilterAttributesWithHTTPInfo(r ApiGetTopFilterAttribut /* GetTopFilterAttributes casts the HTTP response body to a defined struct. -Retrieves the most frequently used filter attributes. +Retrieves the 1,000 most frequently used filter attributes. These are attributes of your records that you included in the `attributesForFaceting` setting. @@ -3582,7 +3668,7 @@ func (r ApiGetTopFilterForAttributeRequest) WithTags(tags string) ApiGetTopFilte /* GetTopFilterForAttribute calls the API and returns the raw response from it. - Retrieves the most frequent filter (facet) values for a filter attribute. + 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. @@ -3658,7 +3744,7 @@ func (c *APIClient) GetTopFilterForAttributeWithHTTPInfo(r ApiGetTopFilterForAtt /* GetTopFilterForAttribute casts the HTTP response body to a defined struct. -Retrieves the most frequent filter (facet) values for a filter attribute. +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. @@ -3830,7 +3916,7 @@ func (r ApiGetTopFiltersNoResultsRequest) WithTags(tags string) ApiGetTopFilters /* GetTopFiltersNoResults calls the API and returns the raw response from it. - Retrieves the most frequently used filters for a search that didn't return any results. + 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. @@ -3901,7 +3987,7 @@ func (c *APIClient) GetTopFiltersNoResultsWithHTTPInfo(r ApiGetTopFiltersNoResul /* GetTopFiltersNoResults casts the HTTP response body to a defined struct. -Retrieves the most frequently used filters for a search that didn't return any results. +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. @@ -4104,7 +4190,29 @@ func (r ApiGetTopHitsRequest) WithTags(tags string) ApiGetTopHitsRequest { /* GetTopHits calls the API and returns the raw response from it. - 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 @@ -4113,7 +4221,7 @@ GetTopHits calls the API and returns the raw response from it. @param index string - Index name. @param search string - Search query. @param clickAnalytics bool - Whether to include metrics related to click and conversion events in the response. - @param revenueAnalytics bool - Whether to include revenue-related metrics in the response. If true, metrics related to click and conversion events are also included in the response. + @param revenueAnalytics bool - Whether to include metrics related to revenue events in the response. @param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format. @param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format. @param limit int32 - Number of items to return. @@ -4181,7 +4289,29 @@ func (c *APIClient) GetTopHitsWithHTTPInfo(r ApiGetTopHitsRequest, opts ...Reque /* GetTopHits casts the HTTP response body to a defined struct. -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 @@ -4191,7 +4321,7 @@ Request can be constructed by NewApiGetTopHitsRequest with parameters below. @param index string - Index name. @param search string - Search query. @param clickAnalytics bool - Whether to include metrics related to click and conversion events in the response. - @param revenueAnalytics bool - Whether to include revenue-related metrics in the response. If true, metrics related to click and conversion events are also included in the response. + @param revenueAnalytics bool - Whether to include metrics related to revenue events in the response. @param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format. @param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format. @param limit int32 - Number of items to return. @@ -4400,7 +4530,29 @@ func (r ApiGetTopSearchesRequest) WithTags(tags string) ApiGetTopSearchesRequest /* GetTopSearches calls the API and returns the raw response from it. - 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 @@ -4408,7 +4560,7 @@ GetTopSearches calls the API and returns the raw response from it. Request can be constructed by NewApiGetTopSearchesRequest with parameters below. @param index string - Index name. @param clickAnalytics bool - Whether to include metrics related to click and conversion events in the response. - @param revenueAnalytics bool - Whether to include revenue-related metrics in the response. If true, metrics related to click and conversion events are also included in the response. + @param revenueAnalytics bool - Whether to include metrics related to revenue events in the response. @param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format. @param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format. @param orderBy OrderBy - Attribute by which to order the response items. If the `clickAnalytics` parameter is false, only `searchCount` is available. @@ -4481,7 +4633,29 @@ func (c *APIClient) GetTopSearchesWithHTTPInfo(r ApiGetTopSearchesRequest, opts /* GetTopSearches casts the HTTP response body to a defined struct. -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 @@ -4490,7 +4664,7 @@ Request can be constructed by NewApiGetTopSearchesRequest with parameters below. @param index string - Index name. @param clickAnalytics bool - Whether to include metrics related to click and conversion events in the response. - @param revenueAnalytics bool - Whether to include revenue-related metrics in the response. If true, metrics related to click and conversion events are also included in the response. + @param revenueAnalytics bool - Whether to include metrics related to revenue events in the response. @param startDate string - Start date of the period to analyze, in `YYYY-MM-DD` format. @param endDate string - End date of the period to analyze, in `YYYY-MM-DD` format. @param orderBy OrderBy - Attribute by which to order the response items. If the `clickAnalytics` parameter is false, only `searchCount` is available. @@ -4607,10 +4781,12 @@ GetUsersCount calls the API and returns the raw response from it. 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. +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. -By default, the analyzed period includes the last eight days including the current day. +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 @@ -4669,10 +4845,12 @@ GetUsersCount casts the HTTP response body to a defined struct. 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. +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. -By default, the analyzed period includes the last eight days including the current day. +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/algolia/analytics/model_daily_add_to_cart_rates.go b/algolia/analytics/model_daily_add_to_cart_rates.go index 2367f0198..ec258dfa5 100644 --- a/algolia/analytics/model_daily_add_to_cart_rates.go +++ b/algolia/analytics/model_daily_add_to_cart_rates.go @@ -10,7 +10,7 @@ import ( // DailyAddToCartRates struct for DailyAddToCartRates. type DailyAddToCartRates struct { - // Add-to-cart rate, calculated as number of tracked searches with at least one add-to-cart event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true. + // Add-to-cart rate: calculated as the number of tracked searches with at least one add-to-cart event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true. Rate utils.Nullable[float64] `json:"rate"` // Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. TrackedSearchCount int32 `json:"trackedSearchCount"` diff --git a/algolia/analytics/model_daily_click_through_rates.go b/algolia/analytics/model_daily_click_through_rates.go index bd86f10de..7a6525b3a 100644 --- a/algolia/analytics/model_daily_click_through_rates.go +++ b/algolia/analytics/model_daily_click_through_rates.go @@ -10,7 +10,7 @@ import ( // DailyClickThroughRates struct for DailyClickThroughRates. type DailyClickThroughRates struct { - // Click-through rate, calculated as number of tracked searches with at least one click event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true. + // Click-through rate: calculated as the number of tracked searches with at least one click event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true. Rate utils.Nullable[float64] `json:"rate"` // Number of clicks associated with this search. ClickCount int32 `json:"clickCount"` diff --git a/algolia/analytics/model_daily_conversion_rates.go b/algolia/analytics/model_daily_conversion_rates.go index 81ec471c7..c09400889 100644 --- a/algolia/analytics/model_daily_conversion_rates.go +++ b/algolia/analytics/model_daily_conversion_rates.go @@ -10,7 +10,7 @@ import ( // DailyConversionRates struct for DailyConversionRates. type DailyConversionRates struct { - // Conversion rate, calculated as number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true. + // Conversion rate: calculated as the number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true. Rate utils.Nullable[float64] `json:"rate"` // Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. TrackedSearchCount int32 `json:"trackedSearchCount"` diff --git a/algolia/analytics/model_daily_no_click_rates.go b/algolia/analytics/model_daily_no_click_rates.go index 2cc636dbc..869a50a2e 100644 --- a/algolia/analytics/model_daily_no_click_rates.go +++ b/algolia/analytics/model_daily_no_click_rates.go @@ -8,7 +8,7 @@ import ( // DailyNoClickRates struct for DailyNoClickRates. type DailyNoClickRates struct { - // No click rate, calculated as number of tracked searches without any click divided by the number of tracked searches. + // No click rate: calculated as the number of tracked searches without clicks divided by the number of tracked searches. Rate float64 `json:"rate"` // Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. Count int32 `json:"count"` diff --git a/algolia/analytics/model_daily_no_results_rates.go b/algolia/analytics/model_daily_no_results_rates.go index f4c340772..67e5dca23 100644 --- a/algolia/analytics/model_daily_no_results_rates.go +++ b/algolia/analytics/model_daily_no_results_rates.go @@ -14,7 +14,7 @@ type DailyNoResultsRates struct { NoResultCount int32 `json:"noResultCount"` // Number of searches. Count int32 `json:"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. Rate float64 `json:"rate"` } diff --git a/algolia/analytics/model_daily_purchase_rates.go b/algolia/analytics/model_daily_purchase_rates.go index 03b8a97f2..245dc1a3c 100644 --- a/algolia/analytics/model_daily_purchase_rates.go +++ b/algolia/analytics/model_daily_purchase_rates.go @@ -10,7 +10,7 @@ import ( // DailyPurchaseRates struct for DailyPurchaseRates. type DailyPurchaseRates struct { - // Purchase rate, calculated as number of tracked searches with at least one purchase event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true. + // Purchase rate: calculated as the number of tracked searches with at least one purchase event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true. Rate utils.Nullable[float64] `json:"rate"` // Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. TrackedSearchCount int32 `json:"trackedSearchCount"` diff --git a/algolia/analytics/model_daily_revenue.go b/algolia/analytics/model_daily_revenue.go index 38a58662f..703f08849 100644 --- a/algolia/analytics/model_daily_revenue.go +++ b/algolia/analytics/model_daily_revenue.go @@ -8,7 +8,7 @@ import ( // DailyRevenue struct for DailyRevenue. type DailyRevenue struct { - // Revenue associated with this search, broken-down by currencies. + // Revenue associated with this search: broken down by currency. Currencies map[string]CurrencyCode `json:"currencies"` // Date in the format YYYY-MM-DD. Date string `json:"date"` diff --git a/algolia/analytics/model_get_add_to_cart_rate_response.go b/algolia/analytics/model_get_add_to_cart_rate_response.go index 4f39d9e86..4bbd0164a 100644 --- a/algolia/analytics/model_get_add_to_cart_rate_response.go +++ b/algolia/analytics/model_get_add_to_cart_rate_response.go @@ -10,7 +10,7 @@ import ( // GetAddToCartRateResponse struct for GetAddToCartRateResponse. type GetAddToCartRateResponse struct { - // Add-to-cart rate, calculated as number of tracked searches with at least one add-to-cart event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true. + // Add-to-cart rate: calculated as the number of tracked searches with at least one add-to-cart event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true. Rate utils.Nullable[float64] `json:"rate"` // Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. TrackedSearchCount int32 `json:"trackedSearchCount"` diff --git a/algolia/analytics/model_get_click_through_rate_response.go b/algolia/analytics/model_get_click_through_rate_response.go index 7dbea6906..686bc9885 100644 --- a/algolia/analytics/model_get_click_through_rate_response.go +++ b/algolia/analytics/model_get_click_through_rate_response.go @@ -10,7 +10,7 @@ import ( // GetClickThroughRateResponse struct for GetClickThroughRateResponse. type GetClickThroughRateResponse struct { - // Click-through rate, calculated as number of tracked searches with at least one click event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true. + // Click-through rate: calculated as the number of tracked searches with at least one click event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true. Rate utils.Nullable[float64] `json:"rate"` // Number of clicks associated with this search. ClickCount int32 `json:"clickCount"` diff --git a/algolia/analytics/model_get_conversion_rate_response.go b/algolia/analytics/model_get_conversion_rate_response.go index 5e021ebd1..a36747ee1 100644 --- a/algolia/analytics/model_get_conversion_rate_response.go +++ b/algolia/analytics/model_get_conversion_rate_response.go @@ -10,7 +10,7 @@ import ( // GetConversionRateResponse struct for GetConversionRateResponse. type GetConversionRateResponse struct { - // Conversion rate, calculated as number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true. + // Conversion rate: calculated as the number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true. Rate utils.Nullable[float64] `json:"rate"` // Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. TrackedSearchCount int32 `json:"trackedSearchCount"` diff --git a/algolia/analytics/model_get_no_click_rate_response.go b/algolia/analytics/model_get_no_click_rate_response.go index ff6205a7d..61af35fc0 100644 --- a/algolia/analytics/model_get_no_click_rate_response.go +++ b/algolia/analytics/model_get_no_click_rate_response.go @@ -8,7 +8,7 @@ import ( // GetNoClickRateResponse struct for GetNoClickRateResponse. type GetNoClickRateResponse struct { - // No click rate, calculated as number of tracked searches without any click divided by the number of tracked searches. + // No click rate: calculated as the number of tracked searches without clicks divided by the number of tracked searches. Rate float64 `json:"rate"` // Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. Count int32 `json:"count"` diff --git a/algolia/analytics/model_get_no_results_rate_response.go b/algolia/analytics/model_get_no_results_rate_response.go index 3985956f3..ccb0180ad 100644 --- a/algolia/analytics/model_get_no_results_rate_response.go +++ b/algolia/analytics/model_get_no_results_rate_response.go @@ -8,7 +8,7 @@ import ( // GetNoResultsRateResponse struct for GetNoResultsRateResponse. type GetNoResultsRateResponse struct { - // No results rate, calculated as number of searches with zero results divided by the total number of searches. + // No results rate: calculated as the number of searches with zero results divided by the total number of searches. Rate float64 `json:"rate"` // Number of searches. Count int32 `json:"count"` diff --git a/algolia/analytics/model_get_purchase_rate_response.go b/algolia/analytics/model_get_purchase_rate_response.go index 8c703226f..972172606 100644 --- a/algolia/analytics/model_get_purchase_rate_response.go +++ b/algolia/analytics/model_get_purchase_rate_response.go @@ -10,7 +10,7 @@ import ( // GetPurchaseRateResponse struct for GetPurchaseRateResponse. type GetPurchaseRateResponse struct { - // Purchase rate, calculated as number of tracked searches with at least one purchase event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true. + // Purchase rate: calculated as the number of tracked searches with at least one purchase event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true. Rate utils.Nullable[float64] `json:"rate"` // Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. TrackedSearchCount int32 `json:"trackedSearchCount"` diff --git a/algolia/analytics/model_get_revenue.go b/algolia/analytics/model_get_revenue.go index 1640f8e79..b5ac8d9c3 100644 --- a/algolia/analytics/model_get_revenue.go +++ b/algolia/analytics/model_get_revenue.go @@ -8,7 +8,7 @@ import ( // GetRevenue struct for GetRevenue. type GetRevenue struct { - // Revenue associated with this search, broken-down by currencies. + // Revenue associated with this search: broken down by currency. Currencies map[string]CurrencyCode `json:"currencies"` // Daily revenue. Dates []DailyRevenue `json:"dates"` diff --git a/algolia/analytics/model_get_top_filters_no_results_response.go b/algolia/analytics/model_get_top_filters_no_results_response.go index f418d44ad..6970a9f77 100644 --- a/algolia/analytics/model_get_top_filters_no_results_response.go +++ b/algolia/analytics/model_get_top_filters_no_results_response.go @@ -8,7 +8,7 @@ import ( // GetTopFiltersNoResultsResponse struct for GetTopFiltersNoResultsResponse. type GetTopFiltersNoResultsResponse struct { - // Filters for searches without any results. If null, the search term specified with the `search` parameter is not a search without results, or the `search` parameter is absent from the request. + // Filters for searches without any results. If null, the search term specified with the `search` parameter isn't a search without results, or the `search` parameter is absent from the request. Values []GetTopFiltersNoResultsValues `json:"values"` } diff --git a/algolia/analytics/model_top_hit.go b/algolia/analytics/model_top_hit.go index 58656a9ca..3e5f45227 100644 --- a/algolia/analytics/model_top_hit.go +++ b/algolia/analytics/model_top_hit.go @@ -8,7 +8,7 @@ import ( // TopHit struct for TopHit. type TopHit struct { - // Object ID of a record that's returned as a search result. + // Object ID of a record returned as a search result. Hit string `json:"hit"` // Number of occurrences. Count int32 `json:"count"` diff --git a/algolia/analytics/model_top_hit_with_analytics.go b/algolia/analytics/model_top_hit_with_analytics.go index 00b3794eb..615e80eb2 100644 --- a/algolia/analytics/model_top_hit_with_analytics.go +++ b/algolia/analytics/model_top_hit_with_analytics.go @@ -10,13 +10,13 @@ import ( // TopHitWithAnalytics struct for TopHitWithAnalytics. type TopHitWithAnalytics struct { - // Object ID of a record that's returned as a search result. + // Object ID of a record returned as a search result. Hit string `json:"hit"` // Number of occurrences. Count int32 `json:"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. ClickThroughRate utils.Nullable[float64] `json:"clickThroughRate"` - // Conversion rate, calculated as number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true. + // Conversion rate: calculated as the number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true. ConversionRate utils.Nullable[float64] `json:"conversionRate"` // Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. TrackedHitCount int32 `json:"trackedHitCount"` diff --git a/algolia/analytics/model_top_hit_with_revenue_analytics.go b/algolia/analytics/model_top_hit_with_revenue_analytics.go index 350376616..8f5e2defd 100644 --- a/algolia/analytics/model_top_hit_with_revenue_analytics.go +++ b/algolia/analytics/model_top_hit_with_revenue_analytics.go @@ -10,13 +10,13 @@ import ( // TopHitWithRevenueAnalytics struct for TopHitWithRevenueAnalytics. type TopHitWithRevenueAnalytics struct { - // Object ID of a record that's returned as a search result. + // Object ID of a record returned as a search result. Hit string `json:"hit"` // Number of occurrences. Count int32 `json:"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. ClickThroughRate utils.Nullable[float64] `json:"clickThroughRate"` - // Conversion rate, calculated as number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true. + // Conversion rate: calculated as the number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true. ConversionRate utils.Nullable[float64] `json:"conversionRate"` // Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. TrackedHitCount int32 `json:"trackedHitCount"` @@ -24,15 +24,15 @@ type TopHitWithRevenueAnalytics struct { ClickCount int32 `json:"clickCount"` // Number of conversions from this search. ConversionCount int32 `json:"conversionCount"` - // Add-to-cart rate, calculated as number of tracked searches with at least one add-to-cart event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true. + // Add-to-cart rate: calculated as the number of tracked searches with at least one add-to-cart event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true. AddToCartRate utils.Nullable[float64] `json:"addToCartRate"` // Number of add-to-cart events from this search. AddToCartCount int32 `json:"addToCartCount"` - // Purchase rate, calculated as number of tracked searches with at least one purchase event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true. + // Purchase rate: calculated as the number of tracked searches with at least one purchase event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true. PurchaseRate utils.Nullable[float64] `json:"purchaseRate"` // Number of purchase events from this search. PurchaseCount int32 `json:"purchaseCount"` - // Revenue associated with this search, broken-down by currencies. + // Revenue associated with this search: broken down by currency. Currencies map[string]CurrencyCode `json:"currencies"` } diff --git a/algolia/analytics/model_top_search_with_analytics.go b/algolia/analytics/model_top_search_with_analytics.go index cb1df3400..92f314964 100644 --- a/algolia/analytics/model_top_search_with_analytics.go +++ b/algolia/analytics/model_top_search_with_analytics.go @@ -14,13 +14,13 @@ type TopSearchWithAnalytics struct { Search string `json:"search"` // Number of searches. Count int32 `json:"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. ClickThroughRate utils.Nullable[float64] `json:"clickThroughRate"` // 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. AverageClickPosition utils.Nullable[float64] `json:"averageClickPosition"` // List of positions in the search results and clicks associated with this search. ClickPositions []ClickPosition `json:"clickPositions"` - // Conversion rate, calculated as number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true. + // Conversion rate: calculated as the number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true. ConversionRate utils.Nullable[float64] `json:"conversionRate"` // Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. TrackedSearchCount int32 `json:"trackedSearchCount"` diff --git a/algolia/analytics/model_top_search_with_revenue_analytics.go b/algolia/analytics/model_top_search_with_revenue_analytics.go index 3765549fb..e3080eaa2 100644 --- a/algolia/analytics/model_top_search_with_revenue_analytics.go +++ b/algolia/analytics/model_top_search_with_revenue_analytics.go @@ -14,13 +14,13 @@ type TopSearchWithRevenueAnalytics struct { Search string `json:"search"` // Number of searches. Count int32 `json:"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. ClickThroughRate utils.Nullable[float64] `json:"clickThroughRate"` // 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. AverageClickPosition utils.Nullable[float64] `json:"averageClickPosition"` // List of positions in the search results and clicks associated with this search. ClickPositions []ClickPosition `json:"clickPositions"` - // Conversion rate, calculated as number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true. + // Conversion rate: calculated as the number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true. ConversionRate utils.Nullable[float64] `json:"conversionRate"` // Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. TrackedSearchCount int32 `json:"trackedSearchCount"` @@ -30,13 +30,13 @@ type TopSearchWithRevenueAnalytics struct { ConversionCount int32 `json:"conversionCount"` // Number of results (hits). NbHits int32 `json:"nbHits"` - // Revenue associated with this search, broken-down by currencies. + // Revenue associated with this search: broken down by currency. Currencies map[string]CurrencyCode `json:"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. AddToCartRate utils.Nullable[float64] `json:"addToCartRate"` // Number of add-to-cart events from this search. AddToCartCount int32 `json:"addToCartCount"` - // Purchase rate, calculated as number of tracked searches with at least one purchase event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true. + // Purchase rate: calculated as the number of tracked searches with at least one purchase event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true. PurchaseRate utils.Nullable[float64] `json:"purchaseRate"` // Number of purchase events from this search. PurchaseCount int32 `json:"purchaseCount"`