Package com.algolia.api

Class AnalyticsClient

java.lang.Object

com.algolia.ApiClient

com.algolia.api.AnalyticsClient

All Implemented Interfaces:

Closeable, AutoCloseable

public class AnalyticsClient
extends ApiClient

Constructor Summary

Constructors

Constructor	Description
AnalyticsClient(String appId, String apiKey)
AnalyticsClient(String appId, String apiKey, ClientOptions options)
AnalyticsClient(String appId, String apiKey, String region)
AnalyticsClient(String appId, String apiKey, String region, ClientOptions options)

Method Summary

Modifier and Type	Method	Description
Object	customDelete(String path)	This method allow you to send requests to the Algolia REST API.
Object	customDelete(String path, RequestOptions requestOptions)	This method allow you to send requests to the Algolia REST API.
Object	customDelete(String path, Map<String,Object> parameters)	This method allow you to send requests to the Algolia REST API.
Object	customDelete(String path, Map<String,Object> parameters, RequestOptions requestOptions)	This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customDeleteAsync(String path)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customDeleteAsync(String path, RequestOptions requestOptions)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customDeleteAsync(String path, Map<String,Object> parameters)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customDeleteAsync(String path, Map<String,Object> parameters, RequestOptions requestOptions)	(asynchronously) This method allow you to send requests to the Algolia REST API.
Object	customGet(String path)	This method allow you to send requests to the Algolia REST API.
Object	customGet(String path, RequestOptions requestOptions)	This method allow you to send requests to the Algolia REST API.
Object	customGet(String path, Map<String,Object> parameters)	This method allow you to send requests to the Algolia REST API.
Object	customGet(String path, Map<String,Object> parameters, RequestOptions requestOptions)	This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customGetAsync(String path)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customGetAsync(String path, RequestOptions requestOptions)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customGetAsync(String path, Map<String,Object> parameters)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customGetAsync(String path, Map<String,Object> parameters, RequestOptions requestOptions)	(asynchronously) This method allow you to send requests to the Algolia REST API.
Object	customPost(String path)	This method allow you to send requests to the Algolia REST API.
Object	customPost(String path, RequestOptions requestOptions)	This method allow you to send requests to the Algolia REST API.
Object	customPost(String path, Map<String,Object> parameters, Object body)	This method allow you to send requests to the Algolia REST API.
Object	customPost(String path, Map<String,Object> parameters, Object body, RequestOptions requestOptions)	This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customPostAsync(String path)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customPostAsync(String path, RequestOptions requestOptions)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customPostAsync(String path, Map<String,Object> parameters, Object body)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customPostAsync(String path, Map<String,Object> parameters, Object body, RequestOptions requestOptions)	(asynchronously) This method allow you to send requests to the Algolia REST API.
Object	customPut(String path)	This method allow you to send requests to the Algolia REST API.
Object	customPut(String path, RequestOptions requestOptions)	This method allow you to send requests to the Algolia REST API.
Object	customPut(String path, Map<String,Object> parameters, Object body)	This method allow you to send requests to the Algolia REST API.
Object	customPut(String path, Map<String,Object> parameters, Object body, RequestOptions requestOptions)	This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customPutAsync(String path)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customPutAsync(String path, RequestOptions requestOptions)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customPutAsync(String path, Map<String,Object> parameters, Object body)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customPutAsync(String path, Map<String,Object> parameters, Object body, RequestOptions requestOptions)	(asynchronously) This method allow you to send requests to the Algolia REST API.
GetAddToCartRateResponse	getAddToCartRate(String index)	Retrieves the add-to-cart rate for all of your searches with at least one add-to-cart event, including a daily breakdown.
GetAddToCartRateResponse	getAddToCartRate(String index, RequestOptions requestOptions)	Retrieves the add-to-cart rate for all of your searches with at least one add-to-cart event, including a daily breakdown.
GetAddToCartRateResponse	getAddToCartRate(String index, String startDate, String endDate, String tags)	Retrieves the add-to-cart rate for all of your searches with at least one add-to-cart event, including a daily breakdown.
GetAddToCartRateResponse	getAddToCartRate(String index, String startDate, String endDate, String tags, RequestOptions requestOptions)	Retrieves the add-to-cart rate for all of your searches with at least one add-to-cart event, including a daily breakdown.
CompletableFuture<GetAddToCartRateResponse>	getAddToCartRateAsync(String index)	(asynchronously) Retrieves the add-to-cart rate for all of your searches with at least one add-to-cart event, including a daily breakdown.
CompletableFuture<GetAddToCartRateResponse>	getAddToCartRateAsync(String index, RequestOptions requestOptions)	(asynchronously) Retrieves the add-to-cart rate for all of your searches with at least one add-to-cart event, including a daily breakdown.
CompletableFuture<GetAddToCartRateResponse>	getAddToCartRateAsync(String index, String startDate, String endDate, String tags)	(asynchronously) Retrieves the add-to-cart rate for all of your searches with at least one add-to-cart event, including a daily breakdown.
CompletableFuture<GetAddToCartRateResponse>	getAddToCartRateAsync(String index, String startDate, String endDate, String tags, RequestOptions requestOptions)	(asynchronously) Retrieves the add-to-cart rate for all of your searches with at least one add-to-cart event, including a daily breakdown.
GetAverageClickPositionResponse	getAverageClickPosition(String index)	Retrieves the average click position of your search results, including a daily breakdown.
GetAverageClickPositionResponse	getAverageClickPosition(String index, RequestOptions requestOptions)	Retrieves the average click position of your search results, including a daily breakdown.
GetAverageClickPositionResponse	getAverageClickPosition(String index, String startDate, String endDate, String tags)	Retrieves the average click position of your search results, including a daily breakdown.
GetAverageClickPositionResponse	getAverageClickPosition(String index, String startDate, String endDate, String tags, RequestOptions requestOptions)	Retrieves the average click position of your search results, including a daily breakdown.
CompletableFuture<GetAverageClickPositionResponse>	getAverageClickPositionAsync(String index)	(asynchronously) Retrieves the average click position of your search results, including a daily breakdown.
CompletableFuture<GetAverageClickPositionResponse>	getAverageClickPositionAsync(String index, RequestOptions requestOptions)	(asynchronously) Retrieves the average click position of your search results, including a daily breakdown.
CompletableFuture<GetAverageClickPositionResponse>	getAverageClickPositionAsync(String index, String startDate, String endDate, String tags)	(asynchronously) Retrieves the average click position of your search results, including a daily breakdown.
CompletableFuture<GetAverageClickPositionResponse>	getAverageClickPositionAsync(String index, String startDate, String endDate, String tags, RequestOptions requestOptions)	(asynchronously) Retrieves the average click position of your search results, including a daily breakdown.
GetClickPositionsResponse	getClickPositions(String index)	Retrieves the positions in the search results and their associated number of clicks.
GetClickPositionsResponse	getClickPositions(String index, RequestOptions requestOptions)	Retrieves the positions in the search results and their associated number of clicks.
GetClickPositionsResponse	getClickPositions(String index, String startDate, String endDate, String tags)	Retrieves the positions in the search results and their associated number of clicks.
GetClickPositionsResponse	getClickPositions(String index, String startDate, String endDate, String tags, RequestOptions requestOptions)	Retrieves the positions in the search results and their associated number of clicks.
CompletableFuture<GetClickPositionsResponse>	getClickPositionsAsync(String index)	(asynchronously) Retrieves the positions in the search results and their associated number of clicks.
CompletableFuture<GetClickPositionsResponse>	getClickPositionsAsync(String index, RequestOptions requestOptions)	(asynchronously) Retrieves the positions in the search results and their associated number of clicks.
CompletableFuture<GetClickPositionsResponse>	getClickPositionsAsync(String index, String startDate, String endDate, String tags)	(asynchronously) Retrieves the positions in the search results and their associated number of clicks.
CompletableFuture<GetClickPositionsResponse>	getClickPositionsAsync(String index, String startDate, String endDate, String tags, RequestOptions requestOptions)	(asynchronously) Retrieves the positions in the search results and their associated number of clicks.
GetClickThroughRateResponse	getClickThroughRate(String index)	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.
GetClickThroughRateResponse	getClickThroughRate(String index, RequestOptions requestOptions)	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.
GetClickThroughRateResponse	getClickThroughRate(String index, String startDate, String endDate, String tags)	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.
GetClickThroughRateResponse	getClickThroughRate(String index, String startDate, String endDate, String tags, RequestOptions requestOptions)	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.
CompletableFuture<GetClickThroughRateResponse>	getClickThroughRateAsync(String index)	(asynchronously) 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.
CompletableFuture<GetClickThroughRateResponse>	getClickThroughRateAsync(String index, RequestOptions requestOptions)	(asynchronously) 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.
CompletableFuture<GetClickThroughRateResponse>	getClickThroughRateAsync(String index, String startDate, String endDate, String tags)	(asynchronously) 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.
CompletableFuture<GetClickThroughRateResponse>	getClickThroughRateAsync(String index, String startDate, String endDate, String tags, RequestOptions requestOptions)	(asynchronously) 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.
GetConversionRateResponse	getConversionRate(String index)	Retrieves the conversion rate for all of your searches with at least one conversion event, including a daily breakdown.
GetConversionRateResponse	getConversionRate(String index, RequestOptions requestOptions)	Retrieves the conversion rate for all of your searches with at least one conversion event, including a daily breakdown.
GetConversionRateResponse	getConversionRate(String index, String startDate, String endDate, String tags)	Retrieves the conversion rate for all of your searches with at least one conversion event, including a daily breakdown.
GetConversionRateResponse	getConversionRate(String index, String startDate, String endDate, String tags, RequestOptions requestOptions)	Retrieves the conversion rate for all of your searches with at least one conversion event, including a daily breakdown.
CompletableFuture<GetConversionRateResponse>	getConversionRateAsync(String index)	(asynchronously) Retrieves the conversion rate for all of your searches with at least one conversion event, including a daily breakdown.
CompletableFuture<GetConversionRateResponse>	getConversionRateAsync(String index, RequestOptions requestOptions)	(asynchronously) Retrieves the conversion rate for all of your searches with at least one conversion event, including a daily breakdown.
CompletableFuture<GetConversionRateResponse>	getConversionRateAsync(String index, String startDate, String endDate, String tags)	(asynchronously) Retrieves the conversion rate for all of your searches with at least one conversion event, including a daily breakdown.
CompletableFuture<GetConversionRateResponse>	getConversionRateAsync(String index, String startDate, String endDate, String tags, RequestOptions requestOptions)	(asynchronously) Retrieves the conversion rate for all of your searches with at least one conversion event, including a daily breakdown.
GetNoClickRateResponse	getNoClickRate(String index)	Retrieves the fraction of searches that didn't lead to any click within a time range, including a daily breakdown.
GetNoClickRateResponse	getNoClickRate(String index, RequestOptions requestOptions)	Retrieves the fraction of searches that didn't lead to any click within a time range, including a daily breakdown.
GetNoClickRateResponse	getNoClickRate(String index, String startDate, String endDate, String tags)	Retrieves the fraction of searches that didn't lead to any click within a time range, including a daily breakdown.
GetNoClickRateResponse	getNoClickRate(String index, String startDate, String endDate, String tags, RequestOptions requestOptions)	Retrieves the fraction of searches that didn't lead to any click within a time range, including a daily breakdown.
CompletableFuture<GetNoClickRateResponse>	getNoClickRateAsync(String index)	(asynchronously) Retrieves the fraction of searches that didn't lead to any click within a time range, including a daily breakdown.
CompletableFuture<GetNoClickRateResponse>	getNoClickRateAsync(String index, RequestOptions requestOptions)	(asynchronously) Retrieves the fraction of searches that didn't lead to any click within a time range, including a daily breakdown.
CompletableFuture<GetNoClickRateResponse>	getNoClickRateAsync(String index, String startDate, String endDate, String tags)	(asynchronously) Retrieves the fraction of searches that didn't lead to any click within a time range, including a daily breakdown.
CompletableFuture<GetNoClickRateResponse>	getNoClickRateAsync(String index, String startDate, String endDate, String tags, RequestOptions requestOptions)	(asynchronously) Retrieves the fraction of searches that didn't lead to any click within a time range, including a daily breakdown.
GetNoResultsRateResponse	getNoResultsRate(String index)	Retrieves the fraction of searches that didn't return any results within a time range, including a daily breakdown.
GetNoResultsRateResponse	getNoResultsRate(String index, RequestOptions requestOptions)	Retrieves the fraction of searches that didn't return any results within a time range, including a daily breakdown.
GetNoResultsRateResponse	getNoResultsRate(String index, String startDate, String endDate, String tags)	Retrieves the fraction of searches that didn't return any results within a time range, including a daily breakdown.
GetNoResultsRateResponse	getNoResultsRate(String index, String startDate, String endDate, String tags, RequestOptions requestOptions)	Retrieves the fraction of searches that didn't return any results within a time range, including a daily breakdown.
CompletableFuture<GetNoResultsRateResponse>	getNoResultsRateAsync(String index)	(asynchronously) Retrieves the fraction of searches that didn't return any results within a time range, including a daily breakdown.
CompletableFuture<GetNoResultsRateResponse>	getNoResultsRateAsync(String index, RequestOptions requestOptions)	(asynchronously) Retrieves the fraction of searches that didn't return any results within a time range, including a daily breakdown.
CompletableFuture<GetNoResultsRateResponse>	getNoResultsRateAsync(String index, String startDate, String endDate, String tags)	(asynchronously) Retrieves the fraction of searches that didn't return any results within a time range, including a daily breakdown.
CompletableFuture<GetNoResultsRateResponse>	getNoResultsRateAsync(String index, String startDate, String endDate, String tags, RequestOptions requestOptions)	(asynchronously) Retrieves the fraction of searches that didn't return any results within a time range, including a daily breakdown.
GetPurchaseRateResponse	getPurchaseRate(String index)	Retrieves the purchase rate for all of your searches with at least one purchase event, including a daily breakdown.
GetPurchaseRateResponse	getPurchaseRate(String index, RequestOptions requestOptions)	Retrieves the purchase rate for all of your searches with at least one purchase event, including a daily breakdown.
GetPurchaseRateResponse	getPurchaseRate(String index, String startDate, String endDate, String tags)	Retrieves the purchase rate for all of your searches with at least one purchase event, including a daily breakdown.
GetPurchaseRateResponse	getPurchaseRate(String index, String startDate, String endDate, String tags, RequestOptions requestOptions)	Retrieves the purchase rate for all of your searches with at least one purchase event, including a daily breakdown.
CompletableFuture<GetPurchaseRateResponse>	getPurchaseRateAsync(String index)	(asynchronously) Retrieves the purchase rate for all of your searches with at least one purchase event, including a daily breakdown.
CompletableFuture<GetPurchaseRateResponse>	getPurchaseRateAsync(String index, RequestOptions requestOptions)	(asynchronously) Retrieves the purchase rate for all of your searches with at least one purchase event, including a daily breakdown.
CompletableFuture<GetPurchaseRateResponse>	getPurchaseRateAsync(String index, String startDate, String endDate, String tags)	(asynchronously) Retrieves the purchase rate for all of your searches with at least one purchase event, including a daily breakdown.
CompletableFuture<GetPurchaseRateResponse>	getPurchaseRateAsync(String index, String startDate, String endDate, String tags, RequestOptions requestOptions)	(asynchronously) Retrieves the purchase rate for all of your searches with at least one purchase event, including a daily breakdown.
GetRevenue	getRevenue(String index)	Retrieves revenue-related metrics, such as the total revenue or the average order value.
GetRevenue	getRevenue(String index, RequestOptions requestOptions)	Retrieves revenue-related metrics, such as the total revenue or the average order value.
GetRevenue	getRevenue(String index, String startDate, String endDate, String tags)	Retrieves revenue-related metrics, such as the total revenue or the average order value.
GetRevenue	getRevenue(String index, String startDate, String endDate, String tags, RequestOptions requestOptions)	Retrieves revenue-related metrics, such as the total revenue or the average order value.
CompletableFuture<GetRevenue>	getRevenueAsync(String index)	(asynchronously) Retrieves revenue-related metrics, such as the total revenue or the average order value.
CompletableFuture<GetRevenue>	getRevenueAsync(String index, RequestOptions requestOptions)	(asynchronously) Retrieves revenue-related metrics, such as the total revenue or the average order value.
CompletableFuture<GetRevenue>	getRevenueAsync(String index, String startDate, String endDate, String tags)	(asynchronously) Retrieves revenue-related metrics, such as the total revenue or the average order value.
CompletableFuture<GetRevenue>	getRevenueAsync(String index, String startDate, String endDate, String tags, RequestOptions requestOptions)	(asynchronously) Retrieves revenue-related metrics, such as the total revenue or the average order value.
GetSearchesCountResponse	getSearchesCount(String index)	Retrieves the number of searches within a time range, including a daily breakdown.
GetSearchesCountResponse	getSearchesCount(String index, RequestOptions requestOptions)	Retrieves the number of searches within a time range, including a daily breakdown.
GetSearchesCountResponse	getSearchesCount(String index, String startDate, String endDate, String tags)	Retrieves the number of searches within a time range, including a daily breakdown.
GetSearchesCountResponse	getSearchesCount(String index, String startDate, String endDate, String tags, RequestOptions requestOptions)	Retrieves the number of searches within a time range, including a daily breakdown.
CompletableFuture<GetSearchesCountResponse>	getSearchesCountAsync(String index)	(asynchronously) Retrieves the number of searches within a time range, including a daily breakdown.
CompletableFuture<GetSearchesCountResponse>	getSearchesCountAsync(String index, RequestOptions requestOptions)	(asynchronously) Retrieves the number of searches within a time range, including a daily breakdown.
CompletableFuture<GetSearchesCountResponse>	getSearchesCountAsync(String index, String startDate, String endDate, String tags)	(asynchronously) Retrieves the number of searches within a time range, including a daily breakdown.
CompletableFuture<GetSearchesCountResponse>	getSearchesCountAsync(String index, String startDate, String endDate, String tags, RequestOptions requestOptions)	(asynchronously) Retrieves the number of searches within a time range, including a daily breakdown.
GetSearchesNoClicksResponse	getSearchesNoClicks(String index)	Retrieves the most popular searches that didn't lead to any clicks, from the 1,000 most frequent searches.
GetSearchesNoClicksResponse	getSearchesNoClicks(String index, RequestOptions requestOptions)	Retrieves the most popular searches that didn't lead to any clicks, from the 1,000 most frequent searches.
GetSearchesNoClicksResponse	getSearchesNoClicks(String index, String startDate, String endDate, Integer limit, Integer offset, String tags)	Retrieves the most popular searches that didn't lead to any clicks, from the 1,000 most frequent searches.
GetSearchesNoClicksResponse	getSearchesNoClicks(String index, String startDate, String endDate, Integer limit, Integer offset, String tags, RequestOptions requestOptions)	Retrieves the most popular searches that didn't lead to any clicks, from the 1,000 most frequent searches.
CompletableFuture<GetSearchesNoClicksResponse>	getSearchesNoClicksAsync(String index)	(asynchronously) Retrieves the most popular searches that didn't lead to any clicks, from the 1,000 most frequent searches.
CompletableFuture<GetSearchesNoClicksResponse>	getSearchesNoClicksAsync(String index, RequestOptions requestOptions)	(asynchronously) Retrieves the most popular searches that didn't lead to any clicks, from the 1,000 most frequent searches.
CompletableFuture<GetSearchesNoClicksResponse>	getSearchesNoClicksAsync(String index, String startDate, String endDate, Integer limit, Integer offset, String tags)	(asynchronously) Retrieves the most popular searches that didn't lead to any clicks, from the 1,000 most frequent searches.
CompletableFuture<GetSearchesNoClicksResponse>	getSearchesNoClicksAsync(String index, String startDate, String endDate, Integer limit, Integer offset, String tags, RequestOptions requestOptions)	(asynchronously) Retrieves the most popular searches that didn't lead to any clicks, from the 1,000 most frequent searches.
GetSearchesNoResultsResponse	getSearchesNoResults(String index)	Retrieves the most popular searches that didn't return any results.
GetSearchesNoResultsResponse	getSearchesNoResults(String index, RequestOptions requestOptions)	Retrieves the most popular searches that didn't return any results.
GetSearchesNoResultsResponse	getSearchesNoResults(String index, String startDate, String endDate, Integer limit, Integer offset, String tags)	Retrieves the most popular searches that didn't return any results.
GetSearchesNoResultsResponse	getSearchesNoResults(String index, String startDate, String endDate, Integer limit, Integer offset, String tags, RequestOptions requestOptions)	Retrieves the most popular searches that didn't return any results.
CompletableFuture<GetSearchesNoResultsResponse>	getSearchesNoResultsAsync(String index)	(asynchronously) Retrieves the most popular searches that didn't return any results.
CompletableFuture<GetSearchesNoResultsResponse>	getSearchesNoResultsAsync(String index, RequestOptions requestOptions)	(asynchronously) Retrieves the most popular searches that didn't return any results.
CompletableFuture<GetSearchesNoResultsResponse>	getSearchesNoResultsAsync(String index, String startDate, String endDate, Integer limit, Integer offset, String tags)	(asynchronously) Retrieves the most popular searches that didn't return any results.
CompletableFuture<GetSearchesNoResultsResponse>	getSearchesNoResultsAsync(String index, String startDate, String endDate, Integer limit, Integer offset, String tags, RequestOptions requestOptions)	(asynchronously) Retrieves the most popular searches that didn't return any results.
GetStatusResponse	getStatus(String index)	Retrieves the time when the Analytics data for the specified index was last updated.
GetStatusResponse	getStatus(String index, RequestOptions requestOptions)	Retrieves the time when the Analytics data for the specified index was last updated.
CompletableFuture<GetStatusResponse>	getStatusAsync(String index)	(asynchronously) Retrieves the time when the Analytics data for the specified index was last updated.
CompletableFuture<GetStatusResponse>	getStatusAsync(String index, RequestOptions requestOptions)	(asynchronously) Retrieves the time when the Analytics data for the specified index was last updated.
GetTopCountriesResponse	getTopCountries(String index)	Retrieves the countries with the most searches to your index.
GetTopCountriesResponse	getTopCountries(String index, RequestOptions requestOptions)	Retrieves the countries with the most searches to your index.
GetTopCountriesResponse	getTopCountries(String index, String startDate, String endDate, Integer limit, Integer offset, String tags)	Retrieves the countries with the most searches to your index.
GetTopCountriesResponse	getTopCountries(String index, String startDate, String endDate, Integer limit, Integer offset, String tags, RequestOptions requestOptions)	Retrieves the countries with the most searches to your index.
CompletableFuture<GetTopCountriesResponse>	getTopCountriesAsync(String index)	(asynchronously) Retrieves the countries with the most searches to your index.
CompletableFuture<GetTopCountriesResponse>	getTopCountriesAsync(String index, RequestOptions requestOptions)	(asynchronously) Retrieves the countries with the most searches to your index.
CompletableFuture<GetTopCountriesResponse>	getTopCountriesAsync(String index, String startDate, String endDate, Integer limit, Integer offset, String tags)	(asynchronously) Retrieves the countries with the most searches to your index.
CompletableFuture<GetTopCountriesResponse>	getTopCountriesAsync(String index, String startDate, String endDate, Integer limit, Integer offset, String tags, RequestOptions requestOptions)	(asynchronously) Retrieves the countries with the most searches to your index.
GetTopFilterAttributesResponse	getTopFilterAttributes(String index)	Retrieves the most frequently used filter attributes.
GetTopFilterAttributesResponse	getTopFilterAttributes(String index, RequestOptions requestOptions)	Retrieves the most frequently used filter attributes.
GetTopFilterAttributesResponse	getTopFilterAttributes(String index, String search, String startDate, String endDate, Integer limit, Integer offset, String tags)	Retrieves the most frequently used filter attributes.
GetTopFilterAttributesResponse	getTopFilterAttributes(String index, String search, String startDate, String endDate, Integer limit, Integer offset, String tags, RequestOptions requestOptions)	Retrieves the most frequently used filter attributes.
CompletableFuture<GetTopFilterAttributesResponse>	getTopFilterAttributesAsync(String index)	(asynchronously) Retrieves the most frequently used filter attributes.
CompletableFuture<GetTopFilterAttributesResponse>	getTopFilterAttributesAsync(String index, RequestOptions requestOptions)	(asynchronously) Retrieves the most frequently used filter attributes.
CompletableFuture<GetTopFilterAttributesResponse>	getTopFilterAttributesAsync(String index, String search, String startDate, String endDate, Integer limit, Integer offset, String tags)	(asynchronously) Retrieves the most frequently used filter attributes.
CompletableFuture<GetTopFilterAttributesResponse>	getTopFilterAttributesAsync(String index, String search, String startDate, String endDate, Integer limit, Integer offset, String tags, RequestOptions requestOptions)	(asynchronously) Retrieves the most frequently used filter attributes.
GetTopFilterForAttributeResponse	getTopFilterForAttribute(String attribute, String index)	Retrieves the most frequent filter (facet) values for a filter attribute.
GetTopFilterForAttributeResponse	getTopFilterForAttribute(String attribute, String index, RequestOptions requestOptions)	Retrieves the most frequent filter (facet) values for a filter attribute.
GetTopFilterForAttributeResponse	getTopFilterForAttribute(String attribute, String index, String search, String startDate, String endDate, Integer limit, Integer offset, String tags)	Retrieves the most frequent filter (facet) values for a filter attribute.
GetTopFilterForAttributeResponse	getTopFilterForAttribute(String attribute, String index, String search, String startDate, String endDate, Integer limit, Integer offset, String tags, RequestOptions requestOptions)	Retrieves the most frequent filter (facet) values for a filter attribute.
CompletableFuture<GetTopFilterForAttributeResponse>	getTopFilterForAttributeAsync(String attribute, String index)	(asynchronously) Retrieves the most frequent filter (facet) values for a filter attribute.
CompletableFuture<GetTopFilterForAttributeResponse>	getTopFilterForAttributeAsync(String attribute, String index, RequestOptions requestOptions)	(asynchronously) Retrieves the most frequent filter (facet) values for a filter attribute.
CompletableFuture<GetTopFilterForAttributeResponse>	getTopFilterForAttributeAsync(String attribute, String index, String search, String startDate, String endDate, Integer limit, Integer offset, String tags)	(asynchronously) Retrieves the most frequent filter (facet) values for a filter attribute.
CompletableFuture<GetTopFilterForAttributeResponse>	getTopFilterForAttributeAsync(String attribute, String index, String search, String startDate, String endDate, Integer limit, Integer offset, String tags, RequestOptions requestOptions)	(asynchronously) Retrieves the most frequent filter (facet) values for a filter attribute.
GetTopFiltersNoResultsResponse	getTopFiltersNoResults(String index)	Retrieves the most frequently used filters for a search that didn't return any results.
GetTopFiltersNoResultsResponse	getTopFiltersNoResults(String index, RequestOptions requestOptions)	Retrieves the most frequently used filters for a search that didn't return any results.
GetTopFiltersNoResultsResponse	getTopFiltersNoResults(String index, String search, String startDate, String endDate, Integer limit, Integer offset, String tags)	Retrieves the most frequently used filters for a search that didn't return any results.
GetTopFiltersNoResultsResponse	getTopFiltersNoResults(String index, String search, String startDate, String endDate, Integer limit, Integer offset, String tags, RequestOptions requestOptions)	Retrieves the most frequently used filters for a search that didn't return any results.
CompletableFuture<GetTopFiltersNoResultsResponse>	getTopFiltersNoResultsAsync(String index)	(asynchronously) Retrieves the most frequently used filters for a search that didn't return any results.
CompletableFuture<GetTopFiltersNoResultsResponse>	getTopFiltersNoResultsAsync(String index, RequestOptions requestOptions)	(asynchronously) Retrieves the most frequently used filters for a search that didn't return any results.
CompletableFuture<GetTopFiltersNoResultsResponse>	getTopFiltersNoResultsAsync(String index, String search, String startDate, String endDate, Integer limit, Integer offset, String tags)	(asynchronously) Retrieves the most frequently used filters for a search that didn't return any results.
CompletableFuture<GetTopFiltersNoResultsResponse>	getTopFiltersNoResultsAsync(String index, String search, String startDate, String endDate, Integer limit, Integer offset, String tags, RequestOptions requestOptions)	(asynchronously) Retrieves the most frequently used filters for a search that didn't return any results.
GetTopHitsResponse	getTopHits(String index)	Retrieves the object IDs of the most frequent search results.
GetTopHitsResponse	getTopHits(String index, RequestOptions requestOptions)	Retrieves the object IDs of the most frequent search results.
GetTopHitsResponse	getTopHits(String index, String search, Boolean clickAnalytics, Boolean revenueAnalytics, String startDate, String endDate, Integer limit, Integer offset, String tags)	Retrieves the object IDs of the most frequent search results.
GetTopHitsResponse	getTopHits(String index, String search, Boolean clickAnalytics, Boolean revenueAnalytics, String startDate, String endDate, Integer limit, Integer offset, String tags, RequestOptions requestOptions)	Retrieves the object IDs of the most frequent search results.
CompletableFuture<GetTopHitsResponse>	getTopHitsAsync(String index)	(asynchronously) Retrieves the object IDs of the most frequent search results.
CompletableFuture<GetTopHitsResponse>	getTopHitsAsync(String index, RequestOptions requestOptions)	(asynchronously) Retrieves the object IDs of the most frequent search results.
CompletableFuture<GetTopHitsResponse>	getTopHitsAsync(String index, String search, Boolean clickAnalytics, Boolean revenueAnalytics, String startDate, String endDate, Integer limit, Integer offset, String tags)	(asynchronously) Retrieves the object IDs of the most frequent search results.
CompletableFuture<GetTopHitsResponse>	getTopHitsAsync(String index, String search, Boolean clickAnalytics, Boolean revenueAnalytics, String startDate, String endDate, Integer limit, Integer offset, String tags, RequestOptions requestOptions)	(asynchronously) Retrieves the object IDs of the most frequent search results.
GetTopSearchesResponse	getTopSearches(String index)	Returns the most popular search terms.
GetTopSearchesResponse	getTopSearches(String index, RequestOptions requestOptions)	Returns the most popular search terms.
GetTopSearchesResponse	getTopSearches(String index, Boolean clickAnalytics, Boolean revenueAnalytics, String startDate, String endDate, OrderBy orderBy, Direction direction, Integer limit, Integer offset, String tags)	Returns the most popular search terms.
GetTopSearchesResponse	getTopSearches(String index, Boolean clickAnalytics, Boolean revenueAnalytics, String startDate, String endDate, OrderBy orderBy, Direction direction, Integer limit, Integer offset, String tags, RequestOptions requestOptions)	Returns the most popular search terms.
CompletableFuture<GetTopSearchesResponse>	getTopSearchesAsync(String index)	(asynchronously) Returns the most popular search terms.
CompletableFuture<GetTopSearchesResponse>	getTopSearchesAsync(String index, RequestOptions requestOptions)	(asynchronously) Returns the most popular search terms.
CompletableFuture<GetTopSearchesResponse>	getTopSearchesAsync(String index, Boolean clickAnalytics, Boolean revenueAnalytics, String startDate, String endDate, OrderBy orderBy, Direction direction, Integer limit, Integer offset, String tags)	(asynchronously) Returns the most popular search terms.
CompletableFuture<GetTopSearchesResponse>	getTopSearchesAsync(String index, Boolean clickAnalytics, Boolean revenueAnalytics, String startDate, String endDate, OrderBy orderBy, Direction direction, Integer limit, Integer offset, String tags, RequestOptions requestOptions)	(asynchronously) Returns the most popular search terms.
GetUsersCountResponse	getUsersCount(String index)	Retrieves the number of unique users within a time range, including a daily breakdown.
GetUsersCountResponse	getUsersCount(String index, RequestOptions requestOptions)	Retrieves the number of unique users within a time range, including a daily breakdown.
GetUsersCountResponse	getUsersCount(String index, String startDate, String endDate, String tags)	Retrieves the number of unique users within a time range, including a daily breakdown.
GetUsersCountResponse	getUsersCount(String index, String startDate, String endDate, String tags, RequestOptions requestOptions)	Retrieves the number of unique users within a time range, including a daily breakdown.
CompletableFuture<GetUsersCountResponse>	getUsersCountAsync(String index)	(asynchronously) Retrieves the number of unique users within a time range, including a daily breakdown.
CompletableFuture<GetUsersCountResponse>	getUsersCountAsync(String index, RequestOptions requestOptions)	(asynchronously) Retrieves the number of unique users within a time range, including a daily breakdown.
CompletableFuture<GetUsersCountResponse>	getUsersCountAsync(String index, String startDate, String endDate, String tags)	(asynchronously) Retrieves the number of unique users within a time range, including a daily breakdown.
CompletableFuture<GetUsersCountResponse>	getUsersCountAsync(String index, String startDate, String endDate, String tags, RequestOptions requestOptions)	(asynchronously) Retrieves the number of unique users within a time range, including a daily breakdown.

Methods inherited from class com.algolia.ApiClient

close, executeAsync, executeAsync, setClientApiKey

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AnalyticsClient

public AnalyticsClient(String appId,
 String apiKey)

AnalyticsClient

public AnalyticsClient(String appId,
 String apiKey,
 ClientOptions options)

AnalyticsClient

public AnalyticsClient(String appId,
 String apiKey,
 String region)

AnalyticsClient

public AnalyticsClient(String appId,
 String apiKey,
 String region,
 ClientOptions options)

Method Details

customDelete

public Object customDelete(@Nonnull
 String path,
 Map<String,Object> parameters,
 RequestOptions requestOptions)
                    throws AlgoliaRuntimeException

This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

parameters - Query parameters to apply to the current query. (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customDelete

public Object customDelete(@Nonnull
 String path,
 Map<String,Object> parameters)
                    throws AlgoliaRuntimeException

This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

parameters - Query parameters to apply to the current query. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customDelete

public Object customDelete(@Nonnull
 String path,
 RequestOptions requestOptions)
                    throws AlgoliaRuntimeException

This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customDelete

public Object customDelete(@Nonnull
 String path)
                    throws AlgoliaRuntimeException

This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customDeleteAsync

public CompletableFuture<Object> customDeleteAsync(@Nonnull
 String path,
 Map<String,Object> parameters,
 RequestOptions requestOptions)
                                            throws AlgoliaRuntimeException

(asynchronously) This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

parameters - Query parameters to apply to the current query. (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customDeleteAsync

public CompletableFuture<Object> customDeleteAsync(@Nonnull
 String path,
 Map<String,Object> parameters)
                                            throws AlgoliaRuntimeException

(asynchronously) This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

parameters - Query parameters to apply to the current query. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customDeleteAsync

public CompletableFuture<Object> customDeleteAsync(@Nonnull
 String path,
 RequestOptions requestOptions)
                                            throws AlgoliaRuntimeException

(asynchronously) This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customDeleteAsync

public CompletableFuture<Object> customDeleteAsync(@Nonnull
 String path)
                                            throws AlgoliaRuntimeException

(asynchronously) This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customGet

public Object customGet(@Nonnull
 String path,
 Map<String,Object> parameters,
 RequestOptions requestOptions)
                 throws AlgoliaRuntimeException

This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

parameters - Query parameters to apply to the current query. (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customGet

public Object customGet(@Nonnull
 String path,
 Map<String,Object> parameters)
                 throws AlgoliaRuntimeException

This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

parameters - Query parameters to apply to the current query. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customGet

public Object customGet(@Nonnull
 String path,
 RequestOptions requestOptions)
                 throws AlgoliaRuntimeException

This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customGet

public Object customGet(@Nonnull
 String path)
                 throws AlgoliaRuntimeException

This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customGetAsync

public CompletableFuture<Object> customGetAsync(@Nonnull
 String path,
 Map<String,Object> parameters,
 RequestOptions requestOptions)
                                         throws AlgoliaRuntimeException

(asynchronously) This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

parameters - Query parameters to apply to the current query. (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customGetAsync

public CompletableFuture<Object> customGetAsync(@Nonnull
 String path,
 Map<String,Object> parameters)
                                         throws AlgoliaRuntimeException

(asynchronously) This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

parameters - Query parameters to apply to the current query. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customGetAsync

public CompletableFuture<Object> customGetAsync(@Nonnull
 String path,
 RequestOptions requestOptions)
                                         throws AlgoliaRuntimeException

(asynchronously) This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customGetAsync

public CompletableFuture<Object> customGetAsync(@Nonnull
 String path)
                                         throws AlgoliaRuntimeException

(asynchronously) This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customPost

public Object customPost(@Nonnull
 String path,
 Map<String,Object> parameters,
 Object body,
 RequestOptions requestOptions)
                  throws AlgoliaRuntimeException

This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

parameters - Query parameters to apply to the current query. (optional)

body - Parameters to send with the custom request. (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customPost

public Object customPost(@Nonnull
 String path,
 Map<String,Object> parameters,
 Object body)
                  throws AlgoliaRuntimeException

This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

parameters - Query parameters to apply to the current query. (optional)

body - Parameters to send with the custom request. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customPost

public Object customPost(@Nonnull
 String path,
 RequestOptions requestOptions)
                  throws AlgoliaRuntimeException

This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customPost

public Object customPost(@Nonnull
 String path)
                  throws AlgoliaRuntimeException

This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customPostAsync

public CompletableFuture<Object> customPostAsync(@Nonnull
 String path,
 Map<String,Object> parameters,
 Object body,
 RequestOptions requestOptions)
                                          throws AlgoliaRuntimeException

(asynchronously) This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

parameters - Query parameters to apply to the current query. (optional)

body - Parameters to send with the custom request. (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customPostAsync

public CompletableFuture<Object> customPostAsync(@Nonnull
 String path,
 Map<String,Object> parameters,
 Object body)
                                          throws AlgoliaRuntimeException

(asynchronously) This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

parameters - Query parameters to apply to the current query. (optional)

body - Parameters to send with the custom request. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customPostAsync

public CompletableFuture<Object> customPostAsync(@Nonnull
 String path,
 RequestOptions requestOptions)
                                          throws AlgoliaRuntimeException

(asynchronously) This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customPostAsync

public CompletableFuture<Object> customPostAsync(@Nonnull
 String path)
                                          throws AlgoliaRuntimeException

(asynchronously) This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customPut

public Object customPut(@Nonnull
 String path,
 Map<String,Object> parameters,
 Object body,
 RequestOptions requestOptions)
                 throws AlgoliaRuntimeException

This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

parameters - Query parameters to apply to the current query. (optional)

body - Parameters to send with the custom request. (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customPut

public Object customPut(@Nonnull
 String path,
 Map<String,Object> parameters,
 Object body)
                 throws AlgoliaRuntimeException

This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

parameters - Query parameters to apply to the current query. (optional)

body - Parameters to send with the custom request. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customPut

public Object customPut(@Nonnull
 String path,
 RequestOptions requestOptions)
                 throws AlgoliaRuntimeException

This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customPut

public Object customPut(@Nonnull
 String path)
                 throws AlgoliaRuntimeException

This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customPutAsync

public CompletableFuture<Object> customPutAsync(@Nonnull
 String path,
 Map<String,Object> parameters,
 Object body,
 RequestOptions requestOptions)
                                         throws AlgoliaRuntimeException

(asynchronously) This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

parameters - Query parameters to apply to the current query. (optional)

body - Parameters to send with the custom request. (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customPutAsync

public CompletableFuture<Object> customPutAsync(@Nonnull
 String path,
 Map<String,Object> parameters,
 Object body)
                                         throws AlgoliaRuntimeException

(asynchronously) This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

parameters - Query parameters to apply to the current query. (optional)

body - Parameters to send with the custom request. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customPutAsync

public CompletableFuture<Object> customPutAsync(@Nonnull
 String path,
 RequestOptions requestOptions)
                                         throws AlgoliaRuntimeException

(asynchronously) This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customPutAsync

public CompletableFuture<Object> customPutAsync(@Nonnull
 String path)
                                         throws AlgoliaRuntimeException

(asynchronously) This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getAddToCartRate

public GetAddToCartRateResponse getAddToCartRate(@Nonnull
 String index,
 String startDate,
 String endDate,
 String tags,
 RequestOptions requestOptions)
                                          throws AlgoliaRuntimeException

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.

Parameters:

index - Index name. (required)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

tags - 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/). (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getAddToCartRate

public GetAddToCartRateResponse getAddToCartRate(@Nonnull
 String index,
 String startDate,
 String endDate,
 String tags)
                                          throws AlgoliaRuntimeException

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.

Parameters:

index - Index name. (required)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

tags - 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/). (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getAddToCartRate

public GetAddToCartRateResponse getAddToCartRate(@Nonnull
 String index,
 RequestOptions requestOptions)
                                          throws AlgoliaRuntimeException

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.

Parameters:

index - Index name. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getAddToCartRate

public GetAddToCartRateResponse getAddToCartRate(@Nonnull
 String index)
                                          throws AlgoliaRuntimeException

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.

Parameters:

index - Index name. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getAddToCartRateAsync

public CompletableFuture<GetAddToCartRateResponse> getAddToCartRateAsync(@Nonnull
 String index,
 String startDate,
 String endDate,
 String tags,
 RequestOptions requestOptions)
                                                                  throws AlgoliaRuntimeException

(asynchronously) 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.

Parameters:

index - Index name. (required)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

tags - 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/). (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getAddToCartRateAsync

public CompletableFuture<GetAddToCartRateResponse> getAddToCartRateAsync(@Nonnull
 String index,
 String startDate,
 String endDate,
 String tags)
                                                                  throws AlgoliaRuntimeException

(asynchronously) 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.

Parameters:

index - Index name. (required)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

tags - 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/). (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getAddToCartRateAsync

public CompletableFuture<GetAddToCartRateResponse> getAddToCartRateAsync(@Nonnull
 String index,
 RequestOptions requestOptions)
                                                                  throws AlgoliaRuntimeException

(asynchronously) 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.

Parameters:

index - Index name. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getAddToCartRateAsync

public CompletableFuture<GetAddToCartRateResponse> getAddToCartRateAsync(@Nonnull
 String index)
                                                                  throws AlgoliaRuntimeException

(asynchronously) 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.

Parameters:

index - Index name. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getAverageClickPosition

public GetAverageClickPositionResponse getAverageClickPosition(@Nonnull
 String index,
 String startDate,
 String endDate,
 String tags,
 RequestOptions requestOptions)
                                                        throws AlgoliaRuntimeException

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.

Parameters:

index - Index name. (required)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

tags - 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/). (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getAverageClickPosition

public GetAverageClickPositionResponse getAverageClickPosition(@Nonnull
 String index,
 String startDate,
 String endDate,
 String tags)
                                                        throws AlgoliaRuntimeException

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.

Parameters:

index - Index name. (required)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

tags - 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/). (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getAverageClickPosition

public GetAverageClickPositionResponse getAverageClickPosition(@Nonnull
 String index,
 RequestOptions requestOptions)
                                                        throws AlgoliaRuntimeException

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.

Parameters:

index - Index name. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getAverageClickPosition

public GetAverageClickPositionResponse getAverageClickPosition(@Nonnull
 String index)
                                                        throws AlgoliaRuntimeException

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.

Parameters:

index - Index name. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getAverageClickPositionAsync

public CompletableFuture<GetAverageClickPositionResponse> getAverageClickPositionAsync(@Nonnull
 String index,
 String startDate,
 String endDate,
 String tags,
 RequestOptions requestOptions)
                                                                                throws AlgoliaRuntimeException

(asynchronously) 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.

Parameters:

index - Index name. (required)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

tags - 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/). (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getAverageClickPositionAsync

public CompletableFuture<GetAverageClickPositionResponse> getAverageClickPositionAsync(@Nonnull
 String index,
 String startDate,
 String endDate,
 String tags)
                                                                                throws AlgoliaRuntimeException

(asynchronously) 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.

Parameters:

index - Index name. (required)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

tags - 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/). (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getAverageClickPositionAsync

public CompletableFuture<GetAverageClickPositionResponse> getAverageClickPositionAsync(@Nonnull
 String index,
 RequestOptions requestOptions)
                                                                                throws AlgoliaRuntimeException

(asynchronously) 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.

Parameters:

index - Index name. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getAverageClickPositionAsync

public CompletableFuture<GetAverageClickPositionResponse> getAverageClickPositionAsync(@Nonnull
 String index)
                                                                                throws AlgoliaRuntimeException

(asynchronously) 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.

Parameters:

index - Index name. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getClickPositions

public GetClickPositionsResponse getClickPositions(@Nonnull
 String index,
 String startDate,
 String endDate,
 String tags,
 RequestOptions requestOptions)
                                            throws AlgoliaRuntimeException

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.

Parameters:

index - Index name. (required)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

tags - 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/). (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getClickPositions

public GetClickPositionsResponse getClickPositions(@Nonnull
 String index,
 String startDate,
 String endDate,
 String tags)
                                            throws AlgoliaRuntimeException

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.

Parameters:

index - Index name. (required)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

tags - 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/). (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getClickPositions

public GetClickPositionsResponse getClickPositions(@Nonnull
 String index,
 RequestOptions requestOptions)
                                            throws AlgoliaRuntimeException

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.

Parameters:

index - Index name. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getClickPositions

public GetClickPositionsResponse getClickPositions(@Nonnull
 String index)
                                            throws AlgoliaRuntimeException

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.

Parameters:

index - Index name. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getClickPositionsAsync

public CompletableFuture<GetClickPositionsResponse> getClickPositionsAsync(@Nonnull
 String index,
 String startDate,
 String endDate,
 String tags,
 RequestOptions requestOptions)
                                                                    throws AlgoliaRuntimeException

(asynchronously) 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.

Parameters:

index - Index name. (required)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

tags - 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/). (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getClickPositionsAsync

public CompletableFuture<GetClickPositionsResponse> getClickPositionsAsync(@Nonnull
 String index,
 String startDate,
 String endDate,
 String tags)
                                                                    throws AlgoliaRuntimeException

(asynchronously) 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.

Parameters:

index - Index name. (required)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

tags - 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/). (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getClickPositionsAsync

public CompletableFuture<GetClickPositionsResponse> getClickPositionsAsync(@Nonnull
 String index,
 RequestOptions requestOptions)
                                                                    throws AlgoliaRuntimeException

(asynchronously) 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.

Parameters:

index - Index name. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getClickPositionsAsync

public CompletableFuture<GetClickPositionsResponse> getClickPositionsAsync(@Nonnull
 String index)
                                                                    throws AlgoliaRuntimeException

(asynchronously) 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.

Parameters:

index - Index name. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getClickThroughRate

public GetClickThroughRateResponse getClickThroughRate(@Nonnull
 String index,
 String startDate,
 String endDate,
 String tags,
 RequestOptions requestOptions)
                                                throws AlgoliaRuntimeException

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.

Parameters:

index - Index name. (required)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

tags - 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/). (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getClickThroughRate

public GetClickThroughRateResponse getClickThroughRate(@Nonnull
 String index,
 String startDate,
 String endDate,
 String tags)
                                                throws AlgoliaRuntimeException

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.

Parameters:

index - Index name. (required)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

tags - 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/). (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getClickThroughRate

public GetClickThroughRateResponse getClickThroughRate(@Nonnull
 String index,
 RequestOptions requestOptions)
                                                throws AlgoliaRuntimeException

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.

Parameters:

index - Index name. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getClickThroughRate

public GetClickThroughRateResponse getClickThroughRate(@Nonnull
 String index)
                                                throws AlgoliaRuntimeException

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.

Parameters:

index - Index name. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getClickThroughRateAsync

public CompletableFuture<GetClickThroughRateResponse> getClickThroughRateAsync(@Nonnull
 String index,
 String startDate,
 String endDate,
 String tags,
 RequestOptions requestOptions)
                                                                        throws AlgoliaRuntimeException

(asynchronously) 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.

Parameters:

index - Index name. (required)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

tags - 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/). (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getClickThroughRateAsync

public CompletableFuture<GetClickThroughRateResponse> getClickThroughRateAsync(@Nonnull
 String index,
 String startDate,
 String endDate,
 String tags)
                                                                        throws AlgoliaRuntimeException

(asynchronously) 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.

Parameters:

index - Index name. (required)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

tags - 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/). (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getClickThroughRateAsync

public CompletableFuture<GetClickThroughRateResponse> getClickThroughRateAsync(@Nonnull
 String index,
 RequestOptions requestOptions)
                                                                        throws AlgoliaRuntimeException

(asynchronously) 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.

Parameters:

index - Index name. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getClickThroughRateAsync

public CompletableFuture<GetClickThroughRateResponse> getClickThroughRateAsync(@Nonnull
 String index)
                                                                        throws AlgoliaRuntimeException

(asynchronously) 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.

Parameters:

index - Index name. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getConversionRate

public GetConversionRateResponse getConversionRate(@Nonnull
 String index,
 String startDate,
 String endDate,
 String tags,
 RequestOptions requestOptions)
                                            throws AlgoliaRuntimeException

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.

Parameters:

index - Index name. (required)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

tags - 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/). (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getConversionRate

public GetConversionRateResponse getConversionRate(@Nonnull
 String index,
 String startDate,
 String endDate,
 String tags)
                                            throws AlgoliaRuntimeException

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.

Parameters:

index - Index name. (required)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

tags - 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/). (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getConversionRate

public GetConversionRateResponse getConversionRate(@Nonnull
 String index,
 RequestOptions requestOptions)
                                            throws AlgoliaRuntimeException

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.

Parameters:

index - Index name. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getConversionRate

public GetConversionRateResponse getConversionRate(@Nonnull
 String index)
                                            throws AlgoliaRuntimeException

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.

Parameters:

index - Index name. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getConversionRateAsync

public CompletableFuture<GetConversionRateResponse> getConversionRateAsync(@Nonnull
 String index,
 String startDate,
 String endDate,
 String tags,
 RequestOptions requestOptions)
                                                                    throws AlgoliaRuntimeException

(asynchronously) 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.

Parameters:

index - Index name. (required)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

tags - 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/). (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getConversionRateAsync

public CompletableFuture<GetConversionRateResponse> getConversionRateAsync(@Nonnull
 String index,
 String startDate,
 String endDate,
 String tags)
                                                                    throws AlgoliaRuntimeException

(asynchronously) 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.

Parameters:

index - Index name. (required)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

tags - 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/). (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getConversionRateAsync

public CompletableFuture<GetConversionRateResponse> getConversionRateAsync(@Nonnull
 String index,
 RequestOptions requestOptions)
                                                                    throws AlgoliaRuntimeException

(asynchronously) 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.

Parameters:

index - Index name. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getConversionRateAsync

public CompletableFuture<GetConversionRateResponse> getConversionRateAsync(@Nonnull
 String index)
                                                                    throws AlgoliaRuntimeException

(asynchronously) 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.

Parameters:

index - Index name. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getNoClickRate

public GetNoClickRateResponse getNoClickRate(@Nonnull
 String index,
 String startDate,
 String endDate,
 String tags,
 RequestOptions requestOptions)
                                      throws AlgoliaRuntimeException

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.

Parameters:

index - Index name. (required)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

tags - 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/). (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getNoClickRate

public GetNoClickRateResponse getNoClickRate(@Nonnull
 String index,
 String startDate,
 String endDate,
 String tags)
                                      throws AlgoliaRuntimeException

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.

Parameters:

index - Index name. (required)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

tags - 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/). (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getNoClickRate

public GetNoClickRateResponse getNoClickRate(@Nonnull
 String index,
 RequestOptions requestOptions)
                                      throws AlgoliaRuntimeException

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.

Parameters:

index - Index name. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getNoClickRate

public GetNoClickRateResponse getNoClickRate(@Nonnull
 String index)
                                      throws AlgoliaRuntimeException

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.

Parameters:

index - Index name. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getNoClickRateAsync

public CompletableFuture<GetNoClickRateResponse> getNoClickRateAsync(@Nonnull
 String index,
 String startDate,
 String endDate,
 String tags,
 RequestOptions requestOptions)
                                                              throws AlgoliaRuntimeException

(asynchronously) 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.

Parameters:

index - Index name. (required)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

tags - 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/). (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getNoClickRateAsync

public CompletableFuture<GetNoClickRateResponse> getNoClickRateAsync(@Nonnull
 String index,
 String startDate,
 String endDate,
 String tags)
                                                              throws AlgoliaRuntimeException

(asynchronously) 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.

Parameters:

index - Index name. (required)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

tags - 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/). (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getNoClickRateAsync

public CompletableFuture<GetNoClickRateResponse> getNoClickRateAsync(@Nonnull
 String index,
 RequestOptions requestOptions)
                                                              throws AlgoliaRuntimeException

(asynchronously) 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.

Parameters:

index - Index name. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getNoClickRateAsync

public CompletableFuture<GetNoClickRateResponse> getNoClickRateAsync(@Nonnull
 String index)
                                                              throws AlgoliaRuntimeException

(asynchronously) 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.

Parameters:

index - Index name. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getNoResultsRate

public GetNoResultsRateResponse getNoResultsRate(@Nonnull
 String index,
 String startDate,
 String endDate,
 String tags,
 RequestOptions requestOptions)
                                          throws AlgoliaRuntimeException

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.

Parameters:

index - Index name. (required)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

tags - 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/). (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getNoResultsRate

public GetNoResultsRateResponse getNoResultsRate(@Nonnull
 String index,
 String startDate,
 String endDate,
 String tags)
                                          throws AlgoliaRuntimeException

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.

Parameters:

index - Index name. (required)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

tags - 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/). (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getNoResultsRate

public GetNoResultsRateResponse getNoResultsRate(@Nonnull
 String index,
 RequestOptions requestOptions)
                                          throws AlgoliaRuntimeException

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.

Parameters:

index - Index name. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getNoResultsRate

public GetNoResultsRateResponse getNoResultsRate(@Nonnull
 String index)
                                          throws AlgoliaRuntimeException

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.

Parameters:

index - Index name. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getNoResultsRateAsync

public CompletableFuture<GetNoResultsRateResponse> getNoResultsRateAsync(@Nonnull
 String index,
 String startDate,
 String endDate,
 String tags,
 RequestOptions requestOptions)
                                                                  throws AlgoliaRuntimeException

(asynchronously) 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.

Parameters:

index - Index name. (required)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

tags - 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/). (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getNoResultsRateAsync

public CompletableFuture<GetNoResultsRateResponse> getNoResultsRateAsync(@Nonnull
 String index,
 String startDate,
 String endDate,
 String tags)
                                                                  throws AlgoliaRuntimeException

(asynchronously) 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.

Parameters:

index - Index name. (required)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

tags - 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/). (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getNoResultsRateAsync

public CompletableFuture<GetNoResultsRateResponse> getNoResultsRateAsync(@Nonnull
 String index,
 RequestOptions requestOptions)
                                                                  throws AlgoliaRuntimeException

(asynchronously) 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.

Parameters:

index - Index name. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getNoResultsRateAsync

public CompletableFuture<GetNoResultsRateResponse> getNoResultsRateAsync(@Nonnull
 String index)
                                                                  throws AlgoliaRuntimeException

(asynchronously) 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.

Parameters:

index - Index name. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getPurchaseRate

public GetPurchaseRateResponse getPurchaseRate(@Nonnull
 String index,
 String startDate,
 String endDate,
 String tags,
 RequestOptions requestOptions)
                                        throws AlgoliaRuntimeException

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.

Parameters:

index - Index name. (required)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

tags - 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/). (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getPurchaseRate

public GetPurchaseRateResponse getPurchaseRate(@Nonnull
 String index,
 String startDate,
 String endDate,
 String tags)
                                        throws AlgoliaRuntimeException

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.

Parameters:

index - Index name. (required)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

tags - 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/). (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getPurchaseRate

public GetPurchaseRateResponse getPurchaseRate(@Nonnull
 String index,
 RequestOptions requestOptions)
                                        throws AlgoliaRuntimeException

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.

Parameters:

index - Index name. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getPurchaseRate

public GetPurchaseRateResponse getPurchaseRate(@Nonnull
 String index)
                                        throws AlgoliaRuntimeException

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.

Parameters:

index - Index name. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getPurchaseRateAsync

public CompletableFuture<GetPurchaseRateResponse> getPurchaseRateAsync(@Nonnull
 String index,
 String startDate,
 String endDate,
 String tags,
 RequestOptions requestOptions)
                                                                throws AlgoliaRuntimeException

(asynchronously) 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.

Parameters:

index - Index name. (required)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

tags - 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/). (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getPurchaseRateAsync

public CompletableFuture<GetPurchaseRateResponse> getPurchaseRateAsync(@Nonnull
 String index,
 String startDate,
 String endDate,
 String tags)
                                                                throws AlgoliaRuntimeException

(asynchronously) 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.

Parameters:

index - Index name. (required)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

tags - 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/). (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getPurchaseRateAsync

public CompletableFuture<GetPurchaseRateResponse> getPurchaseRateAsync(@Nonnull
 String index,
 RequestOptions requestOptions)
                                                                throws AlgoliaRuntimeException

(asynchronously) 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.

Parameters:

index - Index name. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getPurchaseRateAsync

public CompletableFuture<GetPurchaseRateResponse> getPurchaseRateAsync(@Nonnull
 String index)
                                                                throws AlgoliaRuntimeException

(asynchronously) 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.

Parameters:

index - Index name. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getRevenue

public GetRevenue getRevenue(@Nonnull
 String index,
 String startDate,
 String endDate,
 String tags,
 RequestOptions requestOptions)
                      throws AlgoliaRuntimeException

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.

Parameters:

index - Index name. (required)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

tags - 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/). (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getRevenue

public GetRevenue getRevenue(@Nonnull
 String index,
 String startDate,
 String endDate,
 String tags)
                      throws AlgoliaRuntimeException

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.

Parameters:

index - Index name. (required)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

tags - 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/). (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getRevenue

public GetRevenue getRevenue(@Nonnull
 String index,
 RequestOptions requestOptions)
                      throws AlgoliaRuntimeException

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.

Parameters:

index - Index name. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getRevenue

public GetRevenue getRevenue(@Nonnull
 String index)
                      throws AlgoliaRuntimeException

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.

Parameters:

index - Index name. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getRevenueAsync

public CompletableFuture<GetRevenue> getRevenueAsync(@Nonnull
 String index,
 String startDate,
 String endDate,
 String tags,
 RequestOptions requestOptions)
                                              throws AlgoliaRuntimeException

(asynchronously) 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.

Parameters:

index - Index name. (required)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

tags - 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/). (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getRevenueAsync

public CompletableFuture<GetRevenue> getRevenueAsync(@Nonnull
 String index,
 String startDate,
 String endDate,
 String tags)
                                              throws AlgoliaRuntimeException

(asynchronously) 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.

Parameters:

index - Index name. (required)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

tags - 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/). (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getRevenueAsync

public CompletableFuture<GetRevenue> getRevenueAsync(@Nonnull
 String index,
 RequestOptions requestOptions)
                                              throws AlgoliaRuntimeException

(asynchronously) 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.

Parameters:

index - Index name. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getRevenueAsync

public CompletableFuture<GetRevenue> getRevenueAsync(@Nonnull
 String index)
                                              throws AlgoliaRuntimeException

(asynchronously) 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.

Parameters:

index - Index name. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getSearchesCount

public GetSearchesCountResponse getSearchesCount(@Nonnull
 String index,
 String startDate,
 String endDate,
 String tags,
 RequestOptions requestOptions)
                                          throws AlgoliaRuntimeException

Retrieves the number of searches within a time range, including a daily breakdown. By default, the analyzed period includes the last eight days including the current day.

Parameters:

index - Index name. (required)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

tags - 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/). (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getSearchesCount

public GetSearchesCountResponse getSearchesCount(@Nonnull
 String index,
 String startDate,
 String endDate,
 String tags)
                                          throws AlgoliaRuntimeException

Retrieves the number of searches within a time range, including a daily breakdown. By default, the analyzed period includes the last eight days including the current day.

Parameters:

index - Index name. (required)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

tags - 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/). (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getSearchesCount

public GetSearchesCountResponse getSearchesCount(@Nonnull
 String index,
 RequestOptions requestOptions)
                                          throws AlgoliaRuntimeException

Retrieves the number of searches within a time range, including a daily breakdown. By default, the analyzed period includes the last eight days including the current day.

Parameters:

index - Index name. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getSearchesCount

public GetSearchesCountResponse getSearchesCount(@Nonnull
 String index)
                                          throws AlgoliaRuntimeException

Retrieves the number of searches within a time range, including a daily breakdown. By default, the analyzed period includes the last eight days including the current day.

Parameters:

index - Index name. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getSearchesCountAsync

public CompletableFuture<GetSearchesCountResponse> getSearchesCountAsync(@Nonnull
 String index,
 String startDate,
 String endDate,
 String tags,
 RequestOptions requestOptions)
                                                                  throws AlgoliaRuntimeException

(asynchronously) Retrieves the number of searches within a time range, including a daily breakdown. By default, the analyzed period includes the last eight days including the current day.

Parameters:

index - Index name. (required)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

tags - 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/). (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getSearchesCountAsync

public CompletableFuture<GetSearchesCountResponse> getSearchesCountAsync(@Nonnull
 String index,
 String startDate,
 String endDate,
 String tags)
                                                                  throws AlgoliaRuntimeException

(asynchronously) Retrieves the number of searches within a time range, including a daily breakdown. By default, the analyzed period includes the last eight days including the current day.

Parameters:

index - Index name. (required)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

tags - 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/). (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getSearchesCountAsync

public CompletableFuture<GetSearchesCountResponse> getSearchesCountAsync(@Nonnull
 String index,
 RequestOptions requestOptions)
                                                                  throws AlgoliaRuntimeException

(asynchronously) Retrieves the number of searches within a time range, including a daily breakdown. By default, the analyzed period includes the last eight days including the current day.

Parameters:

index - Index name. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getSearchesCountAsync

public CompletableFuture<GetSearchesCountResponse> getSearchesCountAsync(@Nonnull
 String index)
                                                                  throws AlgoliaRuntimeException

(asynchronously) Retrieves the number of searches within a time range, including a daily breakdown. By default, the analyzed period includes the last eight days including the current day.

Parameters:

index - Index name. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getSearchesNoClicks

public GetSearchesNoClicksResponse getSearchesNoClicks(@Nonnull
 String index,
 String startDate,
 String endDate,
 Integer limit,
 Integer offset,
 String tags,
 RequestOptions requestOptions)
                                                throws AlgoliaRuntimeException

Retrieves the most popular searches that didn't lead to any clicks, from the 1,000 most frequent searches.

Parameters:

index - Index name. (required)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

limit - Number of items to return. (optional, default to 10)

offset - Position of the first item to return. (optional, default to 0)

tags - 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/). (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getSearchesNoClicks

public GetSearchesNoClicksResponse getSearchesNoClicks(@Nonnull
 String index,
 String startDate,
 String endDate,
 Integer limit,
 Integer offset,
 String tags)
                                                throws AlgoliaRuntimeException

Retrieves the most popular searches that didn't lead to any clicks, from the 1,000 most frequent searches.

Parameters:

index - Index name. (required)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

limit - Number of items to return. (optional, default to 10)

offset - Position of the first item to return. (optional, default to 0)

tags - 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/). (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getSearchesNoClicks

public GetSearchesNoClicksResponse getSearchesNoClicks(@Nonnull
 String index,
 RequestOptions requestOptions)
                                                throws AlgoliaRuntimeException

Retrieves the most popular searches that didn't lead to any clicks, from the 1,000 most frequent searches.

Parameters:

index - Index name. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getSearchesNoClicks

public GetSearchesNoClicksResponse getSearchesNoClicks(@Nonnull
 String index)
                                                throws AlgoliaRuntimeException

Retrieves the most popular searches that didn't lead to any clicks, from the 1,000 most frequent searches.

Parameters:

index - Index name. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getSearchesNoClicksAsync

public CompletableFuture<GetSearchesNoClicksResponse> getSearchesNoClicksAsync(@Nonnull
 String index,
 String startDate,
 String endDate,
 Integer limit,
 Integer offset,
 String tags,
 RequestOptions requestOptions)
                                                                        throws AlgoliaRuntimeException

(asynchronously) Retrieves the most popular searches that didn't lead to any clicks, from the 1,000 most frequent searches.

Parameters:

index - Index name. (required)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

limit - Number of items to return. (optional, default to 10)

offset - Position of the first item to return. (optional, default to 0)

tags - 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/). (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getSearchesNoClicksAsync

public CompletableFuture<GetSearchesNoClicksResponse> getSearchesNoClicksAsync(@Nonnull
 String index,
 String startDate,
 String endDate,
 Integer limit,
 Integer offset,
 String tags)
                                                                        throws AlgoliaRuntimeException

(asynchronously) Retrieves the most popular searches that didn't lead to any clicks, from the 1,000 most frequent searches.

Parameters:

index - Index name. (required)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

limit - Number of items to return. (optional, default to 10)

offset - Position of the first item to return. (optional, default to 0)

tags - 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/). (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getSearchesNoClicksAsync

public CompletableFuture<GetSearchesNoClicksResponse> getSearchesNoClicksAsync(@Nonnull
 String index,
 RequestOptions requestOptions)
                                                                        throws AlgoliaRuntimeException

(asynchronously) Retrieves the most popular searches that didn't lead to any clicks, from the 1,000 most frequent searches.

Parameters:

index - Index name. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getSearchesNoClicksAsync

public CompletableFuture<GetSearchesNoClicksResponse> getSearchesNoClicksAsync(@Nonnull
 String index)
                                                                        throws AlgoliaRuntimeException

(asynchronously) Retrieves the most popular searches that didn't lead to any clicks, from the 1,000 most frequent searches.

Parameters:

index - Index name. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getSearchesNoResults

public GetSearchesNoResultsResponse getSearchesNoResults(@Nonnull
 String index,
 String startDate,
 String endDate,
 Integer limit,
 Integer offset,
 String tags,
 RequestOptions requestOptions)
                                                  throws AlgoliaRuntimeException

Retrieves the most popular searches that didn't return any results.

Parameters:

index - Index name. (required)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

limit - Number of items to return. (optional, default to 10)

offset - Position of the first item to return. (optional, default to 0)

tags - 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/). (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getSearchesNoResults

public GetSearchesNoResultsResponse getSearchesNoResults(@Nonnull
 String index,
 String startDate,
 String endDate,
 Integer limit,
 Integer offset,
 String tags)
                                                  throws AlgoliaRuntimeException

Retrieves the most popular searches that didn't return any results.

Parameters:

index - Index name. (required)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

limit - Number of items to return. (optional, default to 10)

offset - Position of the first item to return. (optional, default to 0)

tags - 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/). (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getSearchesNoResults

public GetSearchesNoResultsResponse getSearchesNoResults(@Nonnull
 String index,
 RequestOptions requestOptions)
                                                  throws AlgoliaRuntimeException

Retrieves the most popular searches that didn't return any results.

Parameters:

index - Index name. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getSearchesNoResults

public GetSearchesNoResultsResponse getSearchesNoResults(@Nonnull
 String index)
                                                  throws AlgoliaRuntimeException

Retrieves the most popular searches that didn't return any results.

Parameters:

index - Index name. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getSearchesNoResultsAsync

public CompletableFuture<GetSearchesNoResultsResponse> getSearchesNoResultsAsync(@Nonnull
 String index,
 String startDate,
 String endDate,
 Integer limit,
 Integer offset,
 String tags,
 RequestOptions requestOptions)
                                                                          throws AlgoliaRuntimeException

(asynchronously) Retrieves the most popular searches that didn't return any results.

Parameters:

index - Index name. (required)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

limit - Number of items to return. (optional, default to 10)

offset - Position of the first item to return. (optional, default to 0)

tags - 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/). (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getSearchesNoResultsAsync

public CompletableFuture<GetSearchesNoResultsResponse> getSearchesNoResultsAsync(@Nonnull
 String index,
 String startDate,
 String endDate,
 Integer limit,
 Integer offset,
 String tags)
                                                                          throws AlgoliaRuntimeException

(asynchronously) Retrieves the most popular searches that didn't return any results.

Parameters:

index - Index name. (required)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

limit - Number of items to return. (optional, default to 10)

offset - Position of the first item to return. (optional, default to 0)

tags - 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/). (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getSearchesNoResultsAsync

public CompletableFuture<GetSearchesNoResultsResponse> getSearchesNoResultsAsync(@Nonnull
 String index,
 RequestOptions requestOptions)
                                                                          throws AlgoliaRuntimeException

(asynchronously) Retrieves the most popular searches that didn't return any results.

Parameters:

index - Index name. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getSearchesNoResultsAsync

public CompletableFuture<GetSearchesNoResultsResponse> getSearchesNoResultsAsync(@Nonnull
 String index)
                                                                          throws AlgoliaRuntimeException

(asynchronously) Retrieves the most popular searches that didn't return any results.

Parameters:

index - Index name. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getStatus

public GetStatusResponse getStatus(@Nonnull
 String index,
 RequestOptions requestOptions)
                            throws AlgoliaRuntimeException

Retrieves the time when the Analytics data for the specified index was last updated. The Analytics data is updated every 5 minutes.

Parameters:

index - Index name. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getStatus

public GetStatusResponse getStatus(@Nonnull
 String index)
                            throws AlgoliaRuntimeException

Retrieves the time when the Analytics data for the specified index was last updated. The Analytics data is updated every 5 minutes.

Parameters:

index - Index name. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getStatusAsync

public CompletableFuture<GetStatusResponse> getStatusAsync(@Nonnull
 String index,
 RequestOptions requestOptions)
                                                    throws AlgoliaRuntimeException

(asynchronously) Retrieves the time when the Analytics data for the specified index was last updated. The Analytics data is updated every 5 minutes.

Parameters:

index - Index name. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getStatusAsync

public CompletableFuture<GetStatusResponse> getStatusAsync(@Nonnull
 String index)
                                                    throws AlgoliaRuntimeException

(asynchronously) Retrieves the time when the Analytics data for the specified index was last updated. The Analytics data is updated every 5 minutes.

Parameters:

index - Index name. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTopCountries

public GetTopCountriesResponse getTopCountries(@Nonnull
 String index,
 String startDate,
 String endDate,
 Integer limit,
 Integer offset,
 String tags,
 RequestOptions requestOptions)
                                        throws AlgoliaRuntimeException

Retrieves the countries with the most searches to your index.

Parameters:

index - Index name. (required)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

limit - Number of items to return. (optional, default to 10)

offset - Position of the first item to return. (optional, default to 0)

tags - 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/). (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTopCountries

public GetTopCountriesResponse getTopCountries(@Nonnull
 String index,
 String startDate,
 String endDate,
 Integer limit,
 Integer offset,
 String tags)
                                        throws AlgoliaRuntimeException

Retrieves the countries with the most searches to your index.

Parameters:

index - Index name. (required)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

limit - Number of items to return. (optional, default to 10)

offset - Position of the first item to return. (optional, default to 0)

tags - 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/). (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTopCountries

public GetTopCountriesResponse getTopCountries(@Nonnull
 String index,
 RequestOptions requestOptions)
                                        throws AlgoliaRuntimeException

Retrieves the countries with the most searches to your index.

Parameters:

index - Index name. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTopCountries

public GetTopCountriesResponse getTopCountries(@Nonnull
 String index)
                                        throws AlgoliaRuntimeException

Retrieves the countries with the most searches to your index.

Parameters:

index - Index name. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTopCountriesAsync

public CompletableFuture<GetTopCountriesResponse> getTopCountriesAsync(@Nonnull
 String index,
 String startDate,
 String endDate,
 Integer limit,
 Integer offset,
 String tags,
 RequestOptions requestOptions)
                                                                throws AlgoliaRuntimeException

(asynchronously) Retrieves the countries with the most searches to your index.

Parameters:

index - Index name. (required)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

limit - Number of items to return. (optional, default to 10)

offset - Position of the first item to return. (optional, default to 0)

tags - 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/). (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTopCountriesAsync

public CompletableFuture<GetTopCountriesResponse> getTopCountriesAsync(@Nonnull
 String index,
 String startDate,
 String endDate,
 Integer limit,
 Integer offset,
 String tags)
                                                                throws AlgoliaRuntimeException

(asynchronously) Retrieves the countries with the most searches to your index.

Parameters:

index - Index name. (required)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

limit - Number of items to return. (optional, default to 10)

offset - Position of the first item to return. (optional, default to 0)

tags - 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/). (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTopCountriesAsync

public CompletableFuture<GetTopCountriesResponse> getTopCountriesAsync(@Nonnull
 String index,
 RequestOptions requestOptions)
                                                                throws AlgoliaRuntimeException

(asynchronously) Retrieves the countries with the most searches to your index.

Parameters:

index - Index name. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTopCountriesAsync

public CompletableFuture<GetTopCountriesResponse> getTopCountriesAsync(@Nonnull
 String index)
                                                                throws AlgoliaRuntimeException

(asynchronously) Retrieves the countries with the most searches to your index.

Parameters:

index - Index name. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTopFilterAttributes

public GetTopFilterAttributesResponse getTopFilterAttributes(@Nonnull
 String index,
 String search,
 String startDate,
 String endDate,
 Integer limit,
 Integer offset,
 String tags,
 RequestOptions requestOptions)
                                                      throws AlgoliaRuntimeException

Retrieves the most frequently used filter attributes. These are attributes of your records that you included in the `attributesForFaceting` setting.

Parameters:

index - Index name. (required)

search - Search query. (optional)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

limit - Number of items to return. (optional, default to 10)

offset - Position of the first item to return. (optional, default to 0)

tags - 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/). (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTopFilterAttributes

public GetTopFilterAttributesResponse getTopFilterAttributes(@Nonnull
 String index,
 String search,
 String startDate,
 String endDate,
 Integer limit,
 Integer offset,
 String tags)
                                                      throws AlgoliaRuntimeException

Retrieves the most frequently used filter attributes. These are attributes of your records that you included in the `attributesForFaceting` setting.

Parameters:

index - Index name. (required)

search - Search query. (optional)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

limit - Number of items to return. (optional, default to 10)

offset - Position of the first item to return. (optional, default to 0)

tags - 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/). (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTopFilterAttributes

public GetTopFilterAttributesResponse getTopFilterAttributes(@Nonnull
 String index,
 RequestOptions requestOptions)
                                                      throws AlgoliaRuntimeException

Retrieves the most frequently used filter attributes. These are attributes of your records that you included in the `attributesForFaceting` setting.

Parameters:

index - Index name. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTopFilterAttributes

public GetTopFilterAttributesResponse getTopFilterAttributes(@Nonnull
 String index)
                                                      throws AlgoliaRuntimeException

Retrieves the most frequently used filter attributes. These are attributes of your records that you included in the `attributesForFaceting` setting.

Parameters:

index - Index name. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTopFilterAttributesAsync

public CompletableFuture<GetTopFilterAttributesResponse> getTopFilterAttributesAsync(@Nonnull
 String index,
 String search,
 String startDate,
 String endDate,
 Integer limit,
 Integer offset,
 String tags,
 RequestOptions requestOptions)
                                                                              throws AlgoliaRuntimeException

(asynchronously) Retrieves the most frequently used filter attributes. These are attributes of your records that you included in the `attributesForFaceting` setting.

Parameters:

index - Index name. (required)

search - Search query. (optional)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

limit - Number of items to return. (optional, default to 10)

offset - Position of the first item to return. (optional, default to 0)

tags - 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/). (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTopFilterAttributesAsync

public CompletableFuture<GetTopFilterAttributesResponse> getTopFilterAttributesAsync(@Nonnull
 String index,
 String search,
 String startDate,
 String endDate,
 Integer limit,
 Integer offset,
 String tags)
                                                                              throws AlgoliaRuntimeException

(asynchronously) Retrieves the most frequently used filter attributes. These are attributes of your records that you included in the `attributesForFaceting` setting.

Parameters:

index - Index name. (required)

search - Search query. (optional)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

limit - Number of items to return. (optional, default to 10)

offset - Position of the first item to return. (optional, default to 0)

tags - 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/). (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTopFilterAttributesAsync

public CompletableFuture<GetTopFilterAttributesResponse> getTopFilterAttributesAsync(@Nonnull
 String index,
 RequestOptions requestOptions)
                                                                              throws AlgoliaRuntimeException

(asynchronously) Retrieves the most frequently used filter attributes. These are attributes of your records that you included in the `attributesForFaceting` setting.

Parameters:

index - Index name. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTopFilterAttributesAsync

public CompletableFuture<GetTopFilterAttributesResponse> getTopFilterAttributesAsync(@Nonnull
 String index)
                                                                              throws AlgoliaRuntimeException

(asynchronously) Retrieves the most frequently used filter attributes. These are attributes of your records that you included in the `attributesForFaceting` setting.

Parameters:

index - Index name. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTopFilterForAttribute

public GetTopFilterForAttributeResponse getTopFilterForAttribute(@Nonnull
 String attribute,
 @Nonnull
 String index,
 String search,
 String startDate,
 String endDate,
 Integer limit,
 Integer offset,
 String tags,
 RequestOptions requestOptions)
                                                          throws AlgoliaRuntimeException

Retrieves the most frequent filter (facet) values for a filter attribute. These are attributes of your records that you included in the `attributesForFaceting` setting.

Parameters:

attribute - Attribute name. (required)

index - Index name. (required)

search - Search query. (optional)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

limit - Number of items to return. (optional, default to 10)

offset - Position of the first item to return. (optional, default to 0)

tags - 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/). (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTopFilterForAttribute

public GetTopFilterForAttributeResponse getTopFilterForAttribute(@Nonnull
 String attribute,
 @Nonnull
 String index,
 String search,
 String startDate,
 String endDate,
 Integer limit,
 Integer offset,
 String tags)
                                                          throws AlgoliaRuntimeException

Retrieves the most frequent filter (facet) values for a filter attribute. These are attributes of your records that you included in the `attributesForFaceting` setting.

Parameters:

attribute - Attribute name. (required)

index - Index name. (required)

search - Search query. (optional)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

limit - Number of items to return. (optional, default to 10)

offset - Position of the first item to return. (optional, default to 0)

tags - 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/). (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTopFilterForAttribute

public GetTopFilterForAttributeResponse getTopFilterForAttribute(@Nonnull
 String attribute,
 @Nonnull
 String index,
 RequestOptions requestOptions)
                                                          throws AlgoliaRuntimeException

Retrieves the most frequent filter (facet) values for a filter attribute. These are attributes of your records that you included in the `attributesForFaceting` setting.

Parameters:

attribute - Attribute name. (required)

index - Index name. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTopFilterForAttribute

public GetTopFilterForAttributeResponse getTopFilterForAttribute(@Nonnull
 String attribute,
 @Nonnull
 String index)
                                                          throws AlgoliaRuntimeException

Retrieves the most frequent filter (facet) values for a filter attribute. These are attributes of your records that you included in the `attributesForFaceting` setting.

Parameters:

attribute - Attribute name. (required)

index - Index name. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTopFilterForAttributeAsync

public CompletableFuture<GetTopFilterForAttributeResponse> getTopFilterForAttributeAsync(@Nonnull
 String attribute,
 @Nonnull
 String index,
 String search,
 String startDate,
 String endDate,
 Integer limit,
 Integer offset,
 String tags,
 RequestOptions requestOptions)
                                                                                  throws AlgoliaRuntimeException

(asynchronously) Retrieves the most frequent filter (facet) values for a filter attribute. These are attributes of your records that you included in the `attributesForFaceting` setting.

Parameters:

attribute - Attribute name. (required)

index - Index name. (required)

search - Search query. (optional)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

limit - Number of items to return. (optional, default to 10)

offset - Position of the first item to return. (optional, default to 0)

tags - 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/). (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTopFilterForAttributeAsync

public CompletableFuture<GetTopFilterForAttributeResponse> getTopFilterForAttributeAsync(@Nonnull
 String attribute,
 @Nonnull
 String index,
 String search,
 String startDate,
 String endDate,
 Integer limit,
 Integer offset,
 String tags)
                                                                                  throws AlgoliaRuntimeException

(asynchronously) Retrieves the most frequent filter (facet) values for a filter attribute. These are attributes of your records that you included in the `attributesForFaceting` setting.

Parameters:

attribute - Attribute name. (required)

index - Index name. (required)

search - Search query. (optional)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

limit - Number of items to return. (optional, default to 10)

offset - Position of the first item to return. (optional, default to 0)

tags - 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/). (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTopFilterForAttributeAsync

public CompletableFuture<GetTopFilterForAttributeResponse> getTopFilterForAttributeAsync(@Nonnull
 String attribute,
 @Nonnull
 String index,
 RequestOptions requestOptions)
                                                                                  throws AlgoliaRuntimeException

(asynchronously) Retrieves the most frequent filter (facet) values for a filter attribute. These are attributes of your records that you included in the `attributesForFaceting` setting.

Parameters:

attribute - Attribute name. (required)

index - Index name. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTopFilterForAttributeAsync

public CompletableFuture<GetTopFilterForAttributeResponse> getTopFilterForAttributeAsync(@Nonnull
 String attribute,
 @Nonnull
 String index)
                                                                                  throws AlgoliaRuntimeException

(asynchronously) Retrieves the most frequent filter (facet) values for a filter attribute. These are attributes of your records that you included in the `attributesForFaceting` setting.

Parameters:

attribute - Attribute name. (required)

index - Index name. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTopFiltersNoResults

public GetTopFiltersNoResultsResponse getTopFiltersNoResults(@Nonnull
 String index,
 String search,
 String startDate,
 String endDate,
 Integer limit,
 Integer offset,
 String tags,
 RequestOptions requestOptions)
                                                      throws AlgoliaRuntimeException

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.

Parameters:

index - Index name. (required)

search - Search query. (optional)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

limit - Number of items to return. (optional, default to 10)

offset - Position of the first item to return. (optional, default to 0)

tags - 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/). (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTopFiltersNoResults

public GetTopFiltersNoResultsResponse getTopFiltersNoResults(@Nonnull
 String index,
 String search,
 String startDate,
 String endDate,
 Integer limit,
 Integer offset,
 String tags)
                                                      throws AlgoliaRuntimeException

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.

Parameters:

index - Index name. (required)

search - Search query. (optional)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

limit - Number of items to return. (optional, default to 10)

offset - Position of the first item to return. (optional, default to 0)

tags - 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/). (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTopFiltersNoResults

public GetTopFiltersNoResultsResponse getTopFiltersNoResults(@Nonnull
 String index,
 RequestOptions requestOptions)
                                                      throws AlgoliaRuntimeException

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.

Parameters:

index - Index name. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTopFiltersNoResults

public GetTopFiltersNoResultsResponse getTopFiltersNoResults(@Nonnull
 String index)
                                                      throws AlgoliaRuntimeException

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.

Parameters:

index - Index name. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTopFiltersNoResultsAsync

public CompletableFuture<GetTopFiltersNoResultsResponse> getTopFiltersNoResultsAsync(@Nonnull
 String index,
 String search,
 String startDate,
 String endDate,
 Integer limit,
 Integer offset,
 String tags,
 RequestOptions requestOptions)
                                                                              throws AlgoliaRuntimeException

(asynchronously) 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.

Parameters:

index - Index name. (required)

search - Search query. (optional)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

limit - Number of items to return. (optional, default to 10)

offset - Position of the first item to return. (optional, default to 0)

tags - 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/). (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTopFiltersNoResultsAsync

public CompletableFuture<GetTopFiltersNoResultsResponse> getTopFiltersNoResultsAsync(@Nonnull
 String index,
 String search,
 String startDate,
 String endDate,
 Integer limit,
 Integer offset,
 String tags)
                                                                              throws AlgoliaRuntimeException

(asynchronously) 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.

Parameters:

index - Index name. (required)

search - Search query. (optional)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

limit - Number of items to return. (optional, default to 10)

offset - Position of the first item to return. (optional, default to 0)

tags - 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/). (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTopFiltersNoResultsAsync

public CompletableFuture<GetTopFiltersNoResultsResponse> getTopFiltersNoResultsAsync(@Nonnull
 String index,
 RequestOptions requestOptions)
                                                                              throws AlgoliaRuntimeException

(asynchronously) 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.

Parameters:

index - Index name. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTopFiltersNoResultsAsync

public CompletableFuture<GetTopFiltersNoResultsResponse> getTopFiltersNoResultsAsync(@Nonnull
 String index)
                                                                              throws AlgoliaRuntimeException

(asynchronously) 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.

Parameters:

index - Index name. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTopHits

public GetTopHitsResponse getTopHits(@Nonnull
 String index,
 String search,
 Boolean clickAnalytics,
 Boolean revenueAnalytics,
 String startDate,
 String endDate,
 Integer limit,
 Integer offset,
 String tags,
 RequestOptions requestOptions)
                              throws AlgoliaRuntimeException

Retrieves the object IDs of the most frequent search results.

Parameters:

index - Index name. (required)

search - Search query. (optional)

clickAnalytics - Whether to include metrics related to click and conversion events in the response. (optional, default to false)

revenueAnalytics - Whether to include revenue-related metrics in the response. If true, metrics related to click and conversion events are also included in the response. (optional, default to false)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

limit - Number of items to return. (optional, default to 10)

offset - Position of the first item to return. (optional, default to 0)

tags - 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/). (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTopHits

public GetTopHitsResponse getTopHits(@Nonnull
 String index,
 String search,
 Boolean clickAnalytics,
 Boolean revenueAnalytics,
 String startDate,
 String endDate,
 Integer limit,
 Integer offset,
 String tags)
                              throws AlgoliaRuntimeException

Retrieves the object IDs of the most frequent search results.

Parameters:

index - Index name. (required)

search - Search query. (optional)

clickAnalytics - Whether to include metrics related to click and conversion events in the response. (optional, default to false)

revenueAnalytics - Whether to include revenue-related metrics in the response. If true, metrics related to click and conversion events are also included in the response. (optional, default to false)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

limit - Number of items to return. (optional, default to 10)

offset - Position of the first item to return. (optional, default to 0)

tags - 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/). (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTopHits

public GetTopHitsResponse getTopHits(@Nonnull
 String index,
 RequestOptions requestOptions)
                              throws AlgoliaRuntimeException

Retrieves the object IDs of the most frequent search results.

Parameters:

index - Index name. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTopHits

public GetTopHitsResponse getTopHits(@Nonnull
 String index)
                              throws AlgoliaRuntimeException

Retrieves the object IDs of the most frequent search results.

Parameters:

index - Index name. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTopHitsAsync

public CompletableFuture<GetTopHitsResponse> getTopHitsAsync(@Nonnull
 String index,
 String search,
 Boolean clickAnalytics,
 Boolean revenueAnalytics,
 String startDate,
 String endDate,
 Integer limit,
 Integer offset,
 String tags,
 RequestOptions requestOptions)
                                                      throws AlgoliaRuntimeException

(asynchronously) Retrieves the object IDs of the most frequent search results.

Parameters:

index - Index name. (required)

search - Search query. (optional)

clickAnalytics - Whether to include metrics related to click and conversion events in the response. (optional, default to false)

revenueAnalytics - Whether to include revenue-related metrics in the response. If true, metrics related to click and conversion events are also included in the response. (optional, default to false)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

limit - Number of items to return. (optional, default to 10)

offset - Position of the first item to return. (optional, default to 0)

tags - 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/). (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTopHitsAsync

public CompletableFuture<GetTopHitsResponse> getTopHitsAsync(@Nonnull
 String index,
 String search,
 Boolean clickAnalytics,
 Boolean revenueAnalytics,
 String startDate,
 String endDate,
 Integer limit,
 Integer offset,
 String tags)
                                                      throws AlgoliaRuntimeException

(asynchronously) Retrieves the object IDs of the most frequent search results.

Parameters:

index - Index name. (required)

search - Search query. (optional)

clickAnalytics - Whether to include metrics related to click and conversion events in the response. (optional, default to false)

revenueAnalytics - Whether to include revenue-related metrics in the response. If true, metrics related to click and conversion events are also included in the response. (optional, default to false)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

limit - Number of items to return. (optional, default to 10)

offset - Position of the first item to return. (optional, default to 0)

tags - 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/). (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTopHitsAsync

public CompletableFuture<GetTopHitsResponse> getTopHitsAsync(@Nonnull
 String index,
 RequestOptions requestOptions)
                                                      throws AlgoliaRuntimeException

(asynchronously) Retrieves the object IDs of the most frequent search results.

Parameters:

index - Index name. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTopHitsAsync

public CompletableFuture<GetTopHitsResponse> getTopHitsAsync(@Nonnull
 String index)
                                                      throws AlgoliaRuntimeException

(asynchronously) Retrieves the object IDs of the most frequent search results.

Parameters:

index - Index name. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTopSearches

public GetTopSearchesResponse getTopSearches(@Nonnull
 String index,
 Boolean clickAnalytics,
 Boolean revenueAnalytics,
 String startDate,
 String endDate,
 OrderBy orderBy,
 Direction direction,
 Integer limit,
 Integer offset,
 String tags,
 RequestOptions requestOptions)
                                      throws AlgoliaRuntimeException

Returns the most popular search terms.

Parameters:

index - Index name. (required)

clickAnalytics - Whether to include metrics related to click and conversion events in the response. (optional, default to false)

revenueAnalytics - Whether to include revenue-related metrics in the response. If true, metrics related to click and conversion events are also included in the response. (optional, default to false)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

orderBy - Attribute by which to order the response items. If the `clickAnalytics` parameter is false, only `searchCount` is available. (optional, default to searchCount)

direction - Sorting direction of the results: ascending or descending. (optional, default to asc)

limit - Number of items to return. (optional, default to 10)

offset - Position of the first item to return. (optional, default to 0)

tags - 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/). (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTopSearches

public GetTopSearchesResponse getTopSearches(@Nonnull
 String index,
 Boolean clickAnalytics,
 Boolean revenueAnalytics,
 String startDate,
 String endDate,
 OrderBy orderBy,
 Direction direction,
 Integer limit,
 Integer offset,
 String tags)
                                      throws AlgoliaRuntimeException

Returns the most popular search terms.

Parameters:

index - Index name. (required)

clickAnalytics - Whether to include metrics related to click and conversion events in the response. (optional, default to false)

revenueAnalytics - Whether to include revenue-related metrics in the response. If true, metrics related to click and conversion events are also included in the response. (optional, default to false)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

orderBy - Attribute by which to order the response items. If the `clickAnalytics` parameter is false, only `searchCount` is available. (optional, default to searchCount)

direction - Sorting direction of the results: ascending or descending. (optional, default to asc)

limit - Number of items to return. (optional, default to 10)

offset - Position of the first item to return. (optional, default to 0)

tags - 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/). (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTopSearches

public GetTopSearchesResponse getTopSearches(@Nonnull
 String index,
 RequestOptions requestOptions)
                                      throws AlgoliaRuntimeException

Returns the most popular search terms.

Parameters:

index - Index name. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTopSearches

public GetTopSearchesResponse getTopSearches(@Nonnull
 String index)
                                      throws AlgoliaRuntimeException

Returns the most popular search terms.

Parameters:

index - Index name. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTopSearchesAsync

public CompletableFuture<GetTopSearchesResponse> getTopSearchesAsync(@Nonnull
 String index,
 Boolean clickAnalytics,
 Boolean revenueAnalytics,
 String startDate,
 String endDate,
 OrderBy orderBy,
 Direction direction,
 Integer limit,
 Integer offset,
 String tags,
 RequestOptions requestOptions)
                                                              throws AlgoliaRuntimeException

(asynchronously) Returns the most popular search terms.

Parameters:

index - Index name. (required)

clickAnalytics - Whether to include metrics related to click and conversion events in the response. (optional, default to false)

revenueAnalytics - Whether to include revenue-related metrics in the response. If true, metrics related to click and conversion events are also included in the response. (optional, default to false)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

orderBy - Attribute by which to order the response items. If the `clickAnalytics` parameter is false, only `searchCount` is available. (optional, default to searchCount)

direction - Sorting direction of the results: ascending or descending. (optional, default to asc)

limit - Number of items to return. (optional, default to 10)

offset - Position of the first item to return. (optional, default to 0)

tags - 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/). (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTopSearchesAsync

public CompletableFuture<GetTopSearchesResponse> getTopSearchesAsync(@Nonnull
 String index,
 Boolean clickAnalytics,
 Boolean revenueAnalytics,
 String startDate,
 String endDate,
 OrderBy orderBy,
 Direction direction,
 Integer limit,
 Integer offset,
 String tags)
                                                              throws AlgoliaRuntimeException

(asynchronously) Returns the most popular search terms.

Parameters:

index - Index name. (required)

clickAnalytics - Whether to include metrics related to click and conversion events in the response. (optional, default to false)

revenueAnalytics - Whether to include revenue-related metrics in the response. If true, metrics related to click and conversion events are also included in the response. (optional, default to false)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

orderBy - Attribute by which to order the response items. If the `clickAnalytics` parameter is false, only `searchCount` is available. (optional, default to searchCount)

direction - Sorting direction of the results: ascending or descending. (optional, default to asc)

limit - Number of items to return. (optional, default to 10)

offset - Position of the first item to return. (optional, default to 0)

tags - 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/). (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTopSearchesAsync

public CompletableFuture<GetTopSearchesResponse> getTopSearchesAsync(@Nonnull
 String index,
 RequestOptions requestOptions)
                                                              throws AlgoliaRuntimeException

(asynchronously) Returns the most popular search terms.

Parameters:

index - Index name. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTopSearchesAsync

public CompletableFuture<GetTopSearchesResponse> getTopSearchesAsync(@Nonnull
 String index)
                                                              throws AlgoliaRuntimeException

(asynchronously) Returns the most popular search terms.

Parameters:

index - Index name. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getUsersCount

public GetUsersCountResponse getUsersCount(@Nonnull
 String index,
 String startDate,
 String endDate,
 String tags,
 RequestOptions requestOptions)
                                    throws AlgoliaRuntimeException

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.

Parameters:

index - Index name. (required)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

tags - 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/). (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getUsersCount

public GetUsersCountResponse getUsersCount(@Nonnull
 String index,
 String startDate,
 String endDate,
 String tags)
                                    throws AlgoliaRuntimeException

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.

Parameters:

index - Index name. (required)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

tags - 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/). (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getUsersCount

public GetUsersCountResponse getUsersCount(@Nonnull
 String index,
 RequestOptions requestOptions)
                                    throws AlgoliaRuntimeException

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.

Parameters:

index - Index name. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getUsersCount

public GetUsersCountResponse getUsersCount(@Nonnull
 String index)
                                    throws AlgoliaRuntimeException

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.

Parameters:

index - Index name. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getUsersCountAsync

public CompletableFuture<GetUsersCountResponse> getUsersCountAsync(@Nonnull
 String index,
 String startDate,
 String endDate,
 String tags,
 RequestOptions requestOptions)
                                                            throws AlgoliaRuntimeException

(asynchronously) 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.

Parameters:

index - Index name. (required)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

tags - 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/). (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getUsersCountAsync

public CompletableFuture<GetUsersCountResponse> getUsersCountAsync(@Nonnull
 String index,
 String startDate,
 String endDate,
 String tags)
                                                            throws AlgoliaRuntimeException

(asynchronously) 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.

Parameters:

index - Index name. (required)

startDate - Start date of the period to analyze, in `YYYY-MM-DD` format. (optional)

endDate - End date of the period to analyze, in `YYYY-MM-DD` format. (optional)

tags - 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/). (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getUsersCountAsync

public CompletableFuture<GetUsersCountResponse> getUsersCountAsync(@Nonnull
 String index,
 RequestOptions requestOptions)
                                                            throws AlgoliaRuntimeException

(asynchronously) 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.

Parameters:

index - Index name. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getUsersCountAsync

public CompletableFuture<GetUsersCountResponse> getUsersCountAsync(@Nonnull
 String index)
                                                            throws AlgoliaRuntimeException

(asynchronously) 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.

Parameters:

index - Index name. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call