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 Details

  • Method Details

    • del

      public Object del(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

    • del

      public Object del(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

    • del

      public Object del(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

    • del

      public Object del(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

    • delAsync

      public CompletableFuture<Object> delAsync(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

    • delAsync

      public CompletableFuture<Object> delAsync(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

    • delAsync

      public CompletableFuture<Object> delAsync(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

    • delAsync

      public CompletableFuture<Object> delAsync(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

    • get

      public Object get(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

    • get

      public Object get(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

    • get

      public Object get(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

    • get

      public Object get(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

    • getAsync

      public CompletableFuture<Object> getAsync(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

    • getAsync

      public CompletableFuture<Object> getAsync(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

    • getAsync

      public CompletableFuture<Object> getAsync(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

    • getAsync

      public CompletableFuture<Object> getAsync(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

    • getAverageClickPosition

      public GetAverageClickPositionResponse getAverageClickPosition(String index, String startDate, String endDate, String tags, RequestOptions requestOptions) throws AlgoliaRuntimeException
      Return the average click position for the complete time range and for individual days. > **Note**: If all `positions` have a `clickCount` of `0` or `null`, it means Algolia didn't receive any click events for tracked searches. A _tracked_ search is a search request where the `clickAnalytics` parameter is `true`.
      Parameters:
      index - Index name to target. (required)
      startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (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(String index, String startDate, String endDate, String tags) throws AlgoliaRuntimeException
      Return the average click position for the complete time range and for individual days. > **Note**: If all `positions` have a `clickCount` of `0` or `null`, it means Algolia didn't receive any click events for tracked searches. A _tracked_ search is a search request where the `clickAnalytics` parameter is `true`.
      Parameters:
      index - Index name to target. (required)
      startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getAverageClickPosition

      public GetAverageClickPositionResponse getAverageClickPosition(String index, RequestOptions requestOptions) throws AlgoliaRuntimeException
      Return the average click position for the complete time range and for individual days. > **Note**: If all `positions` have a `clickCount` of `0` or `null`, it means Algolia didn't receive any click events for tracked searches. A _tracked_ search is a search request where the `clickAnalytics` parameter is `true`.
      Parameters:
      index - Index name to target. (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(String index) throws AlgoliaRuntimeException
      Return the average click position for the complete time range and for individual days. > **Note**: If all `positions` have a `clickCount` of `0` or `null`, it means Algolia didn't receive any click events for tracked searches. A _tracked_ search is a search request where the `clickAnalytics` parameter is `true`.
      Parameters:
      index - Index name to target. (required)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getAverageClickPositionAsync

      public CompletableFuture<GetAverageClickPositionResponse> getAverageClickPositionAsync(String index, String startDate, String endDate, String tags, RequestOptions requestOptions) throws AlgoliaRuntimeException
      (asynchronously) Return the average click position for the complete time range and for individual days. > **Note**: If all `positions` have a `clickCount` of `0` or `null`, it means Algolia didn't receive any click events for tracked searches. A _tracked_ search is a search request where the `clickAnalytics` parameter is `true`.
      Parameters:
      index - Index name to target. (required)
      startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (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(String index, String startDate, String endDate, String tags) throws AlgoliaRuntimeException
      (asynchronously) Return the average click position for the complete time range and for individual days. > **Note**: If all `positions` have a `clickCount` of `0` or `null`, it means Algolia didn't receive any click events for tracked searches. A _tracked_ search is a search request where the `clickAnalytics` parameter is `true`.
      Parameters:
      index - Index name to target. (required)
      startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getAverageClickPositionAsync

      public CompletableFuture<GetAverageClickPositionResponse> getAverageClickPositionAsync(String index, RequestOptions requestOptions) throws AlgoliaRuntimeException
      (asynchronously) Return the average click position for the complete time range and for individual days. > **Note**: If all `positions` have a `clickCount` of `0` or `null`, it means Algolia didn't receive any click events for tracked searches. A _tracked_ search is a search request where the `clickAnalytics` parameter is `true`.
      Parameters:
      index - Index name to target. (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(String index) throws AlgoliaRuntimeException
      (asynchronously) Return the average click position for the complete time range and for individual days. > **Note**: If all `positions` have a `clickCount` of `0` or `null`, it means Algolia didn't receive any click events for tracked searches. A _tracked_ search is a search request where the `clickAnalytics` parameter is `true`.
      Parameters:
      index - Index name to target. (required)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getClickPositions

      public GetClickPositionsResponse getClickPositions(String index, String startDate, String endDate, String tags, RequestOptions requestOptions) throws AlgoliaRuntimeException
      Show the number of clicks events and their associated position in the search results. > **Note**: If all `positions` have a `clickCount` of `0` or `null`, it means Algolia didn't receive any click events for tracked searches. A _tracked_ search is a search request where the `clickAnalytics` parameter is `true`.
      Parameters:
      index - Index name to target. (required)
      startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (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(String index, String startDate, String endDate, String tags) throws AlgoliaRuntimeException
      Show the number of clicks events and their associated position in the search results. > **Note**: If all `positions` have a `clickCount` of `0` or `null`, it means Algolia didn't receive any click events for tracked searches. A _tracked_ search is a search request where the `clickAnalytics` parameter is `true`.
      Parameters:
      index - Index name to target. (required)
      startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getClickPositions

      public GetClickPositionsResponse getClickPositions(String index, RequestOptions requestOptions) throws AlgoliaRuntimeException
      Show the number of clicks events and their associated position in the search results. > **Note**: If all `positions` have a `clickCount` of `0` or `null`, it means Algolia didn't receive any click events for tracked searches. A _tracked_ search is a search request where the `clickAnalytics` parameter is `true`.
      Parameters:
      index - Index name to target. (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(String index) throws AlgoliaRuntimeException
      Show the number of clicks events and their associated position in the search results. > **Note**: If all `positions` have a `clickCount` of `0` or `null`, it means Algolia didn't receive any click events for tracked searches. A _tracked_ search is a search request where the `clickAnalytics` parameter is `true`.
      Parameters:
      index - Index name to target. (required)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getClickPositionsAsync

      public CompletableFuture<GetClickPositionsResponse> getClickPositionsAsync(String index, String startDate, String endDate, String tags, RequestOptions requestOptions) throws AlgoliaRuntimeException
      (asynchronously) Show the number of clicks events and their associated position in the search results. > **Note**: If all `positions` have a `clickCount` of `0` or `null`, it means Algolia didn't receive any click events for tracked searches. A _tracked_ search is a search request where the `clickAnalytics` parameter is `true`.
      Parameters:
      index - Index name to target. (required)
      startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (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(String index, String startDate, String endDate, String tags) throws AlgoliaRuntimeException
      (asynchronously) Show the number of clicks events and their associated position in the search results. > **Note**: If all `positions` have a `clickCount` of `0` or `null`, it means Algolia didn't receive any click events for tracked searches. A _tracked_ search is a search request where the `clickAnalytics` parameter is `true`.
      Parameters:
      index - Index name to target. (required)
      startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getClickPositionsAsync

      public CompletableFuture<GetClickPositionsResponse> getClickPositionsAsync(String index, RequestOptions requestOptions) throws AlgoliaRuntimeException
      (asynchronously) Show the number of clicks events and their associated position in the search results. > **Note**: If all `positions` have a `clickCount` of `0` or `null`, it means Algolia didn't receive any click events for tracked searches. A _tracked_ search is a search request where the `clickAnalytics` parameter is `true`.
      Parameters:
      index - Index name to target. (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(String index) throws AlgoliaRuntimeException
      (asynchronously) Show the number of clicks events and their associated position in the search results. > **Note**: If all `positions` have a `clickCount` of `0` or `null`, it means Algolia didn't receive any click events for tracked searches. A _tracked_ search is a search request where the `clickAnalytics` parameter is `true`.
      Parameters:
      index - Index name to target. (required)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getClickThroughRate

      public GetClickThroughRateResponse getClickThroughRate(String index, String startDate, String endDate, String tags, RequestOptions requestOptions) throws AlgoliaRuntimeException
      Returns a [click-through rate (CTR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate).
      Parameters:
      index - Index name to target. (required)
      startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (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(String index, String startDate, String endDate, String tags) throws AlgoliaRuntimeException
      Returns a [click-through rate (CTR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate).
      Parameters:
      index - Index name to target. (required)
      startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getClickThroughRate

      public GetClickThroughRateResponse getClickThroughRate(String index, RequestOptions requestOptions) throws AlgoliaRuntimeException
      Returns a [click-through rate (CTR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate).
      Parameters:
      index - Index name to target. (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(String index) throws AlgoliaRuntimeException
      Returns a [click-through rate (CTR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate).
      Parameters:
      index - Index name to target. (required)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getClickThroughRateAsync

      public CompletableFuture<GetClickThroughRateResponse> getClickThroughRateAsync(String index, String startDate, String endDate, String tags, RequestOptions requestOptions) throws AlgoliaRuntimeException
      (asynchronously) Returns a [click-through rate (CTR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate).
      Parameters:
      index - Index name to target. (required)
      startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (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(String index, String startDate, String endDate, String tags) throws AlgoliaRuntimeException
      (asynchronously) Returns a [click-through rate (CTR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate).
      Parameters:
      index - Index name to target. (required)
      startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getClickThroughRateAsync

      public CompletableFuture<GetClickThroughRateResponse> getClickThroughRateAsync(String index, RequestOptions requestOptions) throws AlgoliaRuntimeException
      (asynchronously) Returns a [click-through rate (CTR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate).
      Parameters:
      index - Index name to target. (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(String index) throws AlgoliaRuntimeException
      (asynchronously) Returns a [click-through rate (CTR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate).
      Parameters:
      index - Index name to target. (required)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getConversationRate

      public GetConversationRateResponse getConversationRate(String index, String startDate, String endDate, String tags, RequestOptions requestOptions) throws AlgoliaRuntimeException
      Return a [conversion rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#conversion-rate).
      Parameters:
      index - Index name to target. (required)
      startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (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

    • getConversationRate

      public GetConversationRateResponse getConversationRate(String index, String startDate, String endDate, String tags) throws AlgoliaRuntimeException
      Return a [conversion rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#conversion-rate).
      Parameters:
      index - Index name to target. (required)
      startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getConversationRate

      public GetConversationRateResponse getConversationRate(String index, RequestOptions requestOptions) throws AlgoliaRuntimeException
      Return a [conversion rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#conversion-rate).
      Parameters:
      index - Index name to target. (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

    • getConversationRate

      public GetConversationRateResponse getConversationRate(String index) throws AlgoliaRuntimeException
      Return a [conversion rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#conversion-rate).
      Parameters:
      index - Index name to target. (required)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getConversationRateAsync

      public CompletableFuture<GetConversationRateResponse> getConversationRateAsync(String index, String startDate, String endDate, String tags, RequestOptions requestOptions) throws AlgoliaRuntimeException
      (asynchronously) Return a [conversion rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#conversion-rate).
      Parameters:
      index - Index name to target. (required)
      startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (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

    • getConversationRateAsync

      public CompletableFuture<GetConversationRateResponse> getConversationRateAsync(String index, String startDate, String endDate, String tags) throws AlgoliaRuntimeException
      (asynchronously) Return a [conversion rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#conversion-rate).
      Parameters:
      index - Index name to target. (required)
      startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getConversationRateAsync

      public CompletableFuture<GetConversationRateResponse> getConversationRateAsync(String index, RequestOptions requestOptions) throws AlgoliaRuntimeException
      (asynchronously) Return a [conversion rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#conversion-rate).
      Parameters:
      index - Index name to target. (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

    • getConversationRateAsync

      public CompletableFuture<GetConversationRateResponse> getConversationRateAsync(String index) throws AlgoliaRuntimeException
      (asynchronously) Return a [conversion rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#conversion-rate).
      Parameters:
      index - Index name to target. (required)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getNoClickRate

      public GetNoClickRateResponse getNoClickRate(String index, String startDate, String endDate, String tags, RequestOptions requestOptions) throws AlgoliaRuntimeException
      Returns the rate at which searches don't lead to any clicks. The endpoint returns a value for the complete given time range, as well as a value per day. It also returns the count of searches and searches without clicks.
      Parameters:
      index - Index name to target. (required)
      startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (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(String index, String startDate, String endDate, String tags) throws AlgoliaRuntimeException
      Returns the rate at which searches don't lead to any clicks. The endpoint returns a value for the complete given time range, as well as a value per day. It also returns the count of searches and searches without clicks.
      Parameters:
      index - Index name to target. (required)
      startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getNoClickRate

      public GetNoClickRateResponse getNoClickRate(String index, RequestOptions requestOptions) throws AlgoliaRuntimeException
      Returns the rate at which searches don't lead to any clicks. The endpoint returns a value for the complete given time range, as well as a value per day. It also returns the count of searches and searches without clicks.
      Parameters:
      index - Index name to target. (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(String index) throws AlgoliaRuntimeException
      Returns the rate at which searches don't lead to any clicks. The endpoint returns a value for the complete given time range, as well as a value per day. It also returns the count of searches and searches without clicks.
      Parameters:
      index - Index name to target. (required)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getNoClickRateAsync

      public CompletableFuture<GetNoClickRateResponse> getNoClickRateAsync(String index, String startDate, String endDate, String tags, RequestOptions requestOptions) throws AlgoliaRuntimeException
      (asynchronously) Returns the rate at which searches don't lead to any clicks. The endpoint returns a value for the complete given time range, as well as a value per day. It also returns the count of searches and searches without clicks.
      Parameters:
      index - Index name to target. (required)
      startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (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(String index, String startDate, String endDate, String tags) throws AlgoliaRuntimeException
      (asynchronously) Returns the rate at which searches don't lead to any clicks. The endpoint returns a value for the complete given time range, as well as a value per day. It also returns the count of searches and searches without clicks.
      Parameters:
      index - Index name to target. (required)
      startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getNoClickRateAsync

      public CompletableFuture<GetNoClickRateResponse> getNoClickRateAsync(String index, RequestOptions requestOptions) throws AlgoliaRuntimeException
      (asynchronously) Returns the rate at which searches don't lead to any clicks. The endpoint returns a value for the complete given time range, as well as a value per day. It also returns the count of searches and searches without clicks.
      Parameters:
      index - Index name to target. (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(String index) throws AlgoliaRuntimeException
      (asynchronously) Returns the rate at which searches don't lead to any clicks. The endpoint returns a value for the complete given time range, as well as a value per day. It also returns the count of searches and searches without clicks.
      Parameters:
      index - Index name to target. (required)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getNoResultsRate

      public GetNoResultsRateResponse getNoResultsRate(String index, String startDate, String endDate, String tags, RequestOptions requestOptions) throws AlgoliaRuntimeException
      Returns the rate at which searches didn't return any results.
      Parameters:
      index - Index name to target. (required)
      startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (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(String index, String startDate, String endDate, String tags) throws AlgoliaRuntimeException
      Returns the rate at which searches didn't return any results.
      Parameters:
      index - Index name to target. (required)
      startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getNoResultsRate

      public GetNoResultsRateResponse getNoResultsRate(String index, RequestOptions requestOptions) throws AlgoliaRuntimeException
      Returns the rate at which searches didn't return any results.
      Parameters:
      index - Index name to target. (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(String index) throws AlgoliaRuntimeException
      Returns the rate at which searches didn't return any results.
      Parameters:
      index - Index name to target. (required)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getNoResultsRateAsync

      public CompletableFuture<GetNoResultsRateResponse> getNoResultsRateAsync(String index, String startDate, String endDate, String tags, RequestOptions requestOptions) throws AlgoliaRuntimeException
      (asynchronously) Returns the rate at which searches didn't return any results.
      Parameters:
      index - Index name to target. (required)
      startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (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(String index, String startDate, String endDate, String tags) throws AlgoliaRuntimeException
      (asynchronously) Returns the rate at which searches didn't return any results.
      Parameters:
      index - Index name to target. (required)
      startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getNoResultsRateAsync

      public CompletableFuture<GetNoResultsRateResponse> getNoResultsRateAsync(String index, RequestOptions requestOptions) throws AlgoliaRuntimeException
      (asynchronously) Returns the rate at which searches didn't return any results.
      Parameters:
      index - Index name to target. (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(String index) throws AlgoliaRuntimeException
      (asynchronously) Returns the rate at which searches didn't return any results.
      Parameters:
      index - Index name to target. (required)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getSearchesCount

      public GetSearchesCountResponse getSearchesCount(String index, String startDate, String endDate, String tags, RequestOptions requestOptions) throws AlgoliaRuntimeException
      Returns the number of searches within a time range.
      Parameters:
      index - Index name to target. (required)
      startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (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(String index, String startDate, String endDate, String tags) throws AlgoliaRuntimeException
      Returns the number of searches within a time range.
      Parameters:
      index - Index name to target. (required)
      startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getSearchesCount

      public GetSearchesCountResponse getSearchesCount(String index, RequestOptions requestOptions) throws AlgoliaRuntimeException
      Returns the number of searches within a time range.
      Parameters:
      index - Index name to target. (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(String index) throws AlgoliaRuntimeException
      Returns the number of searches within a time range.
      Parameters:
      index - Index name to target. (required)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getSearchesCountAsync

      public CompletableFuture<GetSearchesCountResponse> getSearchesCountAsync(String index, String startDate, String endDate, String tags, RequestOptions requestOptions) throws AlgoliaRuntimeException
      (asynchronously) Returns the number of searches within a time range.
      Parameters:
      index - Index name to target. (required)
      startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (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(String index, String startDate, String endDate, String tags) throws AlgoliaRuntimeException
      (asynchronously) Returns the number of searches within a time range.
      Parameters:
      index - Index name to target. (required)
      startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getSearchesCountAsync

      public CompletableFuture<GetSearchesCountResponse> getSearchesCountAsync(String index, RequestOptions requestOptions) throws AlgoliaRuntimeException
      (asynchronously) Returns the number of searches within a time range.
      Parameters:
      index - Index name to target. (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(String index) throws AlgoliaRuntimeException
      (asynchronously) Returns the number of searches within a time range.
      Parameters:
      index - Index name to target. (required)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getSearchesNoClicks

      public GetSearchesNoClicksResponse getSearchesNoClicks(String index, String startDate, String endDate, Integer limit, Integer offset, String tags, RequestOptions requestOptions) throws AlgoliaRuntimeException
      Return the most popular of the last 1,000 searches that didn't lead to any clicks.
      Parameters:
      index - Index name to target. (required)
      startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      limit - Number of records to return (page size). (optional, default to 10)
      offset - Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
      tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (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(String index, String startDate, String endDate, Integer limit, Integer offset, String tags) throws AlgoliaRuntimeException
      Return the most popular of the last 1,000 searches that didn't lead to any clicks.
      Parameters:
      index - Index name to target. (required)
      startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      limit - Number of records to return (page size). (optional, default to 10)
      offset - Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
      tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getSearchesNoClicks

      public GetSearchesNoClicksResponse getSearchesNoClicks(String index, RequestOptions requestOptions) throws AlgoliaRuntimeException
      Return the most popular of the last 1,000 searches that didn't lead to any clicks.
      Parameters:
      index - Index name to target. (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(String index) throws AlgoliaRuntimeException
      Return the most popular of the last 1,000 searches that didn't lead to any clicks.
      Parameters:
      index - Index name to target. (required)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getSearchesNoClicksAsync

      public CompletableFuture<GetSearchesNoClicksResponse> getSearchesNoClicksAsync(String index, String startDate, String endDate, Integer limit, Integer offset, String tags, RequestOptions requestOptions) throws AlgoliaRuntimeException
      (asynchronously) Return the most popular of the last 1,000 searches that didn't lead to any clicks.
      Parameters:
      index - Index name to target. (required)
      startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      limit - Number of records to return (page size). (optional, default to 10)
      offset - Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
      tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (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(String index, String startDate, String endDate, Integer limit, Integer offset, String tags) throws AlgoliaRuntimeException
      (asynchronously) Return the most popular of the last 1,000 searches that didn't lead to any clicks.
      Parameters:
      index - Index name to target. (required)
      startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      limit - Number of records to return (page size). (optional, default to 10)
      offset - Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
      tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getSearchesNoClicksAsync

      public CompletableFuture<GetSearchesNoClicksResponse> getSearchesNoClicksAsync(String index, RequestOptions requestOptions) throws AlgoliaRuntimeException
      (asynchronously) Return the most popular of the last 1,000 searches that didn't lead to any clicks.
      Parameters:
      index - Index name to target. (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(String index) throws AlgoliaRuntimeException
      (asynchronously) Return the most popular of the last 1,000 searches that didn't lead to any clicks.
      Parameters:
      index - Index name to target. (required)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getSearchesNoResults

      public GetSearchesNoResultsResponse getSearchesNoResults(String index, String startDate, String endDate, Integer limit, Integer offset, String tags, RequestOptions requestOptions) throws AlgoliaRuntimeException
      Returns the most popular of the latest 1,000 searches that didn't return any results.
      Parameters:
      index - Index name to target. (required)
      startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      limit - Number of records to return (page size). (optional, default to 10)
      offset - Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
      tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (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(String index, String startDate, String endDate, Integer limit, Integer offset, String tags) throws AlgoliaRuntimeException
      Returns the most popular of the latest 1,000 searches that didn't return any results.
      Parameters:
      index - Index name to target. (required)
      startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      limit - Number of records to return (page size). (optional, default to 10)
      offset - Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
      tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getSearchesNoResults

      public GetSearchesNoResultsResponse getSearchesNoResults(String index, RequestOptions requestOptions) throws AlgoliaRuntimeException
      Returns the most popular of the latest 1,000 searches that didn't return any results.
      Parameters:
      index - Index name to target. (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(String index) throws AlgoliaRuntimeException
      Returns the most popular of the latest 1,000 searches that didn't return any results.
      Parameters:
      index - Index name to target. (required)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getSearchesNoResultsAsync

      public CompletableFuture<GetSearchesNoResultsResponse> getSearchesNoResultsAsync(String index, String startDate, String endDate, Integer limit, Integer offset, String tags, RequestOptions requestOptions) throws AlgoliaRuntimeException
      (asynchronously) Returns the most popular of the latest 1,000 searches that didn't return any results.
      Parameters:
      index - Index name to target. (required)
      startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      limit - Number of records to return (page size). (optional, default to 10)
      offset - Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
      tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (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(String index, String startDate, String endDate, Integer limit, Integer offset, String tags) throws AlgoliaRuntimeException
      (asynchronously) Returns the most popular of the latest 1,000 searches that didn't return any results.
      Parameters:
      index - Index name to target. (required)
      startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      limit - Number of records to return (page size). (optional, default to 10)
      offset - Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
      tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getSearchesNoResultsAsync

      public CompletableFuture<GetSearchesNoResultsResponse> getSearchesNoResultsAsync(String index, RequestOptions requestOptions) throws AlgoliaRuntimeException
      (asynchronously) Returns the most popular of the latest 1,000 searches that didn't return any results.
      Parameters:
      index - Index name to target. (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(String index) throws AlgoliaRuntimeException
      (asynchronously) Returns the most popular of the latest 1,000 searches that didn't return any results.
      Parameters:
      index - Index name to target. (required)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getStatus

      public GetStatusResponse getStatus(String index, RequestOptions requestOptions) throws AlgoliaRuntimeException
      Return the latest update time of the Analytics API for an index. If the index has been recently created or no search has been performed yet, `updatedAt` will be `null`. > **Note**: The Analytics API is updated every 5 minutes.
      Parameters:
      index - Index name to target. (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(String index) throws AlgoliaRuntimeException
      Return the latest update time of the Analytics API for an index. If the index has been recently created or no search has been performed yet, `updatedAt` will be `null`. > **Note**: The Analytics API is updated every 5 minutes.
      Parameters:
      index - Index name to target. (required)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getStatusAsync

      public CompletableFuture<GetStatusResponse> getStatusAsync(String index, RequestOptions requestOptions) throws AlgoliaRuntimeException
      (asynchronously) Return the latest update time of the Analytics API for an index. If the index has been recently created or no search has been performed yet, `updatedAt` will be `null`. > **Note**: The Analytics API is updated every 5&nbsp;minutes.
      Parameters:
      index - Index name to target. (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(String index) throws AlgoliaRuntimeException
      (asynchronously) Return the latest update time of the Analytics API for an index. If the index has been recently created or no search has been performed yet, `updatedAt` will be `null`. > **Note**: The Analytics API is updated every 5&nbsp;minutes.
      Parameters:
      index - Index name to target. (required)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getTopCountries

      public GetTopCountriesResponse getTopCountries(String index, String startDate, String endDate, Integer limit, Integer offset, String tags, RequestOptions requestOptions) throws AlgoliaRuntimeException
      Returns top countries. Limited to the 1,000 most frequent ones.
      Parameters:
      index - Index name to target. (required)
      startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      limit - Number of records to return (page size). (optional, default to 10)
      offset - Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
      tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (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(String index, String startDate, String endDate, Integer limit, Integer offset, String tags) throws AlgoliaRuntimeException
      Returns top countries. Limited to the 1,000 most frequent ones.
      Parameters:
      index - Index name to target. (required)
      startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      limit - Number of records to return (page size). (optional, default to 10)
      offset - Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
      tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getTopCountries

      public GetTopCountriesResponse getTopCountries(String index, RequestOptions requestOptions) throws AlgoliaRuntimeException
      Returns top countries. Limited to the 1,000 most frequent ones.
      Parameters:
      index - Index name to target. (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(String index) throws AlgoliaRuntimeException
      Returns top countries. Limited to the 1,000 most frequent ones.
      Parameters:
      index - Index name to target. (required)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getTopCountriesAsync

      public CompletableFuture<GetTopCountriesResponse> getTopCountriesAsync(String index, String startDate, String endDate, Integer limit, Integer offset, String tags, RequestOptions requestOptions) throws AlgoliaRuntimeException
      (asynchronously) Returns top countries. Limited to the 1,000 most frequent ones.
      Parameters:
      index - Index name to target. (required)
      startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      limit - Number of records to return (page size). (optional, default to 10)
      offset - Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
      tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (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(String index, String startDate, String endDate, Integer limit, Integer offset, String tags) throws AlgoliaRuntimeException
      (asynchronously) Returns top countries. Limited to the 1,000 most frequent ones.
      Parameters:
      index - Index name to target. (required)
      startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      limit - Number of records to return (page size). (optional, default to 10)
      offset - Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
      tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getTopCountriesAsync

      public CompletableFuture<GetTopCountriesResponse> getTopCountriesAsync(String index, RequestOptions requestOptions) throws AlgoliaRuntimeException
      (asynchronously) Returns top countries. Limited to the 1,000 most frequent ones.
      Parameters:
      index - Index name to target. (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(String index) throws AlgoliaRuntimeException
      (asynchronously) Returns top countries. Limited to the 1,000 most frequent ones.
      Parameters:
      index - Index name to target. (required)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getTopFilterAttributes

      public GetTopFilterAttributesResponse getTopFilterAttributes(String index, String search, String startDate, String endDate, Integer limit, Integer offset, String tags, RequestOptions requestOptions) throws AlgoliaRuntimeException
      Return the most popular [filterable attributes](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/) in the 1,000 most recently used filters.
      Parameters:
      index - Index name to target. (required)
      search - User query. (optional)
      startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      limit - Number of records to return (page size). (optional, default to 10)
      offset - Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
      tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (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(String index, String search, String startDate, String endDate, Integer limit, Integer offset, String tags) throws AlgoliaRuntimeException
      Return the most popular [filterable attributes](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/) in the 1,000 most recently used filters.
      Parameters:
      index - Index name to target. (required)
      search - User query. (optional)
      startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      limit - Number of records to return (page size). (optional, default to 10)
      offset - Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
      tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getTopFilterAttributes

      public GetTopFilterAttributesResponse getTopFilterAttributes(String index, RequestOptions requestOptions) throws AlgoliaRuntimeException
      Return the most popular [filterable attributes](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/) in the 1,000 most recently used filters.
      Parameters:
      index - Index name to target. (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(String index) throws AlgoliaRuntimeException
      Return the most popular [filterable attributes](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/) in the 1,000 most recently used filters.
      Parameters:
      index - Index name to target. (required)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getTopFilterAttributesAsync

      public CompletableFuture<GetTopFilterAttributesResponse> getTopFilterAttributesAsync(String index, String search, String startDate, String endDate, Integer limit, Integer offset, String tags, RequestOptions requestOptions) throws AlgoliaRuntimeException
      (asynchronously) Return the most popular [filterable attributes](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/) in the 1,000 most recently used filters.
      Parameters:
      index - Index name to target. (required)
      search - User query. (optional)
      startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      limit - Number of records to return (page size). (optional, default to 10)
      offset - Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
      tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (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(String index, String search, String startDate, String endDate, Integer limit, Integer offset, String tags) throws AlgoliaRuntimeException
      (asynchronously) Return the most popular [filterable attributes](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/) in the 1,000 most recently used filters.
      Parameters:
      index - Index name to target. (required)
      search - User query. (optional)
      startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      limit - Number of records to return (page size). (optional, default to 10)
      offset - Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
      tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getTopFilterAttributesAsync

      public CompletableFuture<GetTopFilterAttributesResponse> getTopFilterAttributesAsync(String index, RequestOptions requestOptions) throws AlgoliaRuntimeException
      (asynchronously) Return the most popular [filterable attributes](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/) in the 1,000 most recently used filters.
      Parameters:
      index - Index name to target. (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(String index) throws AlgoliaRuntimeException
      (asynchronously) Return the most popular [filterable attributes](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/) in the 1,000 most recently used filters.
      Parameters:
      index - Index name to target. (required)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getTopFilterForAttribute

      public GetTopFilterForAttributeResponse getTopFilterForAttribute(String attribute, String index, String search, String startDate, String endDate, Integer limit, Integer offset, String tags, RequestOptions requestOptions) throws AlgoliaRuntimeException
      Returns the most popular filter values for an attribute in the 1,000 most recently used filters.
      Parameters:
      attribute - Attribute name. (required)
      index - Index name to target. (required)
      search - User query. (optional)
      startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      limit - Number of records to return (page size). (optional, default to 10)
      offset - Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
      tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (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(String attribute, String index, String search, String startDate, String endDate, Integer limit, Integer offset, String tags) throws AlgoliaRuntimeException
      Returns the most popular filter values for an attribute in the 1,000 most recently used filters.
      Parameters:
      attribute - Attribute name. (required)
      index - Index name to target. (required)
      search - User query. (optional)
      startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      limit - Number of records to return (page size). (optional, default to 10)
      offset - Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
      tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getTopFilterForAttribute

      public GetTopFilterForAttributeResponse getTopFilterForAttribute(String attribute, String index, RequestOptions requestOptions) throws AlgoliaRuntimeException
      Returns the most popular filter values for an attribute in the 1,000 most recently used filters.
      Parameters:
      attribute - Attribute name. (required)
      index - Index name to target. (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(String attribute, String index) throws AlgoliaRuntimeException
      Returns the most popular filter values for an attribute in the 1,000 most recently used filters.
      Parameters:
      attribute - Attribute name. (required)
      index - Index name to target. (required)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getTopFilterForAttributeAsync

      public CompletableFuture<GetTopFilterForAttributeResponse> getTopFilterForAttributeAsync(String attribute, String index, String search, String startDate, String endDate, Integer limit, Integer offset, String tags, RequestOptions requestOptions) throws AlgoliaRuntimeException
      (asynchronously) Returns the most popular filter values for an attribute in the 1,000 most recently used filters.
      Parameters:
      attribute - Attribute name. (required)
      index - Index name to target. (required)
      search - User query. (optional)
      startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      limit - Number of records to return (page size). (optional, default to 10)
      offset - Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
      tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (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(String attribute, String index, String search, String startDate, String endDate, Integer limit, Integer offset, String tags) throws AlgoliaRuntimeException
      (asynchronously) Returns the most popular filter values for an attribute in the 1,000 most recently used filters.
      Parameters:
      attribute - Attribute name. (required)
      index - Index name to target. (required)
      search - User query. (optional)
      startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      limit - Number of records to return (page size). (optional, default to 10)
      offset - Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
      tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getTopFilterForAttributeAsync

      public CompletableFuture<GetTopFilterForAttributeResponse> getTopFilterForAttributeAsync(String attribute, String index, RequestOptions requestOptions) throws AlgoliaRuntimeException
      (asynchronously) Returns the most popular filter values for an attribute in the 1,000 most recently used filters.
      Parameters:
      attribute - Attribute name. (required)
      index - Index name to target. (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(String attribute, String index) throws AlgoliaRuntimeException
      (asynchronously) Returns the most popular filter values for an attribute in the 1,000 most recently used filters.
      Parameters:
      attribute - Attribute name. (required)
      index - Index name to target. (required)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getTopFiltersNoResults

      public GetTopFiltersNoResultsResponse getTopFiltersNoResults(String index, String search, String startDate, String endDate, Integer limit, Integer offset, String tags, RequestOptions requestOptions) throws AlgoliaRuntimeException
      Returns top filters for filter-enabled searches that don't return results. Limited to the 1,000 most recently used filters.
      Parameters:
      index - Index name to target. (required)
      search - User query. (optional)
      startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      limit - Number of records to return (page size). (optional, default to 10)
      offset - Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
      tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (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(String index, String search, String startDate, String endDate, Integer limit, Integer offset, String tags) throws AlgoliaRuntimeException
      Returns top filters for filter-enabled searches that don't return results. Limited to the 1,000 most recently used filters.
      Parameters:
      index - Index name to target. (required)
      search - User query. (optional)
      startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      limit - Number of records to return (page size). (optional, default to 10)
      offset - Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
      tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getTopFiltersNoResults

      public GetTopFiltersNoResultsResponse getTopFiltersNoResults(String index, RequestOptions requestOptions) throws AlgoliaRuntimeException
      Returns top filters for filter-enabled searches that don't return results. Limited to the 1,000 most recently used filters.
      Parameters:
      index - Index name to target. (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(String index) throws AlgoliaRuntimeException
      Returns top filters for filter-enabled searches that don't return results. Limited to the 1,000 most recently used filters.
      Parameters:
      index - Index name to target. (required)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getTopFiltersNoResultsAsync

      public CompletableFuture<GetTopFiltersNoResultsResponse> getTopFiltersNoResultsAsync(String index, String search, String startDate, String endDate, Integer limit, Integer offset, String tags, RequestOptions requestOptions) throws AlgoliaRuntimeException
      (asynchronously) Returns top filters for filter-enabled searches that don't return results. Limited to the 1,000 most recently used filters.
      Parameters:
      index - Index name to target. (required)
      search - User query. (optional)
      startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      limit - Number of records to return (page size). (optional, default to 10)
      offset - Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
      tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (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(String index, String search, String startDate, String endDate, Integer limit, Integer offset, String tags) throws AlgoliaRuntimeException
      (asynchronously) Returns top filters for filter-enabled searches that don't return results. Limited to the 1,000 most recently used filters.
      Parameters:
      index - Index name to target. (required)
      search - User query. (optional)
      startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      limit - Number of records to return (page size). (optional, default to 10)
      offset - Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
      tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getTopFiltersNoResultsAsync

      public CompletableFuture<GetTopFiltersNoResultsResponse> getTopFiltersNoResultsAsync(String index, RequestOptions requestOptions) throws AlgoliaRuntimeException
      (asynchronously) Returns top filters for filter-enabled searches that don't return results. Limited to the 1,000 most recently used filters.
      Parameters:
      index - Index name to target. (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(String index) throws AlgoliaRuntimeException
      (asynchronously) Returns top filters for filter-enabled searches that don't return results. Limited to the 1,000 most recently used filters.
      Parameters:
      index - Index name to target. (required)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getTopHits

      public GetTopHitsResponse getTopHits(String index, String search, Boolean clickAnalytics, String startDate, String endDate, Integer limit, Integer offset, String tags, RequestOptions requestOptions) throws AlgoliaRuntimeException
      Return the most popular clicked results in the last 1,000 searches.
      Parameters:
      index - Index name to target. (required)
      search - User query. (optional)
      clickAnalytics - Whether to include [click and conversion](https://www.algolia.com/doc/guides/sending-events/getting-started/) rates for a search. (optional, default to false)
      startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      limit - Number of records to return (page size). (optional, default to 10)
      offset - Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
      tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (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(String index, String search, Boolean clickAnalytics, String startDate, String endDate, Integer limit, Integer offset, String tags) throws AlgoliaRuntimeException
      Return the most popular clicked results in the last 1,000 searches.
      Parameters:
      index - Index name to target. (required)
      search - User query. (optional)
      clickAnalytics - Whether to include [click and conversion](https://www.algolia.com/doc/guides/sending-events/getting-started/) rates for a search. (optional, default to false)
      startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      limit - Number of records to return (page size). (optional, default to 10)
      offset - Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
      tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getTopHits

      public GetTopHitsResponse getTopHits(String index, RequestOptions requestOptions) throws AlgoliaRuntimeException
      Return the most popular clicked results in the last 1,000 searches.
      Parameters:
      index - Index name to target. (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(String index) throws AlgoliaRuntimeException
      Return the most popular clicked results in the last 1,000 searches.
      Parameters:
      index - Index name to target. (required)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getTopHitsAsync

      public CompletableFuture<GetTopHitsResponse> getTopHitsAsync(String index, String search, Boolean clickAnalytics, String startDate, String endDate, Integer limit, Integer offset, String tags, RequestOptions requestOptions) throws AlgoliaRuntimeException
      (asynchronously) Return the most popular clicked results in the last 1,000 searches.
      Parameters:
      index - Index name to target. (required)
      search - User query. (optional)
      clickAnalytics - Whether to include [click and conversion](https://www.algolia.com/doc/guides/sending-events/getting-started/) rates for a search. (optional, default to false)
      startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      limit - Number of records to return (page size). (optional, default to 10)
      offset - Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
      tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (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(String index, String search, Boolean clickAnalytics, String startDate, String endDate, Integer limit, Integer offset, String tags) throws AlgoliaRuntimeException
      (asynchronously) Return the most popular clicked results in the last 1,000 searches.
      Parameters:
      index - Index name to target. (required)
      search - User query. (optional)
      clickAnalytics - Whether to include [click and conversion](https://www.algolia.com/doc/guides/sending-events/getting-started/) rates for a search. (optional, default to false)
      startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      limit - Number of records to return (page size). (optional, default to 10)
      offset - Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
      tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getTopHitsAsync

      public CompletableFuture<GetTopHitsResponse> getTopHitsAsync(String index, RequestOptions requestOptions) throws AlgoliaRuntimeException
      (asynchronously) Return the most popular clicked results in the last 1,000 searches.
      Parameters:
      index - Index name to target. (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(String index) throws AlgoliaRuntimeException
      (asynchronously) Return the most popular clicked results in the last 1,000 searches.
      Parameters:
      index - Index name to target. (required)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getTopSearches

      public GetTopSearchesResponse getTopSearches(String index, Boolean clickAnalytics, String startDate, String endDate, OrderBy orderBy, Direction direction, Integer limit, Integer offset, String tags, RequestOptions requestOptions) throws AlgoliaRuntimeException
      Returns the most popular of the latest 1,000 searches. For each search, also returns the number of hits.
      Parameters:
      index - Index name to target. (required)
      clickAnalytics - Whether to include [click and conversion](https://www.algolia.com/doc/guides/sending-events/getting-started/) rates for a search. (optional, default to false)
      startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      orderBy - Reorder the results. (optional, default to searchCount)
      direction - Sorting direction of the results: ascending or descending. (optional, default to asc)
      limit - Number of records to return (page size). (optional, default to 10)
      offset - Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
      tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (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(String index, Boolean clickAnalytics, String startDate, String endDate, OrderBy orderBy, Direction direction, Integer limit, Integer offset, String tags) throws AlgoliaRuntimeException
      Returns the most popular of the latest 1,000 searches. For each search, also returns the number of hits.
      Parameters:
      index - Index name to target. (required)
      clickAnalytics - Whether to include [click and conversion](https://www.algolia.com/doc/guides/sending-events/getting-started/) rates for a search. (optional, default to false)
      startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      orderBy - Reorder the results. (optional, default to searchCount)
      direction - Sorting direction of the results: ascending or descending. (optional, default to asc)
      limit - Number of records to return (page size). (optional, default to 10)
      offset - Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
      tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getTopSearches

      public GetTopSearchesResponse getTopSearches(String index, RequestOptions requestOptions) throws AlgoliaRuntimeException
      Returns the most popular of the latest 1,000 searches. For each search, also returns the number of hits.
      Parameters:
      index - Index name to target. (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(String index) throws AlgoliaRuntimeException
      Returns the most popular of the latest 1,000 searches. For each search, also returns the number of hits.
      Parameters:
      index - Index name to target. (required)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getTopSearchesAsync

      public CompletableFuture<GetTopSearchesResponse> getTopSearchesAsync(String index, Boolean clickAnalytics, String startDate, String endDate, OrderBy orderBy, Direction direction, Integer limit, Integer offset, String tags, RequestOptions requestOptions) throws AlgoliaRuntimeException
      (asynchronously) Returns the most popular of the latest 1,000 searches. For each search, also returns the number of hits.
      Parameters:
      index - Index name to target. (required)
      clickAnalytics - Whether to include [click and conversion](https://www.algolia.com/doc/guides/sending-events/getting-started/) rates for a search. (optional, default to false)
      startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      orderBy - Reorder the results. (optional, default to searchCount)
      direction - Sorting direction of the results: ascending or descending. (optional, default to asc)
      limit - Number of records to return (page size). (optional, default to 10)
      offset - Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
      tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (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(String index, Boolean clickAnalytics, String startDate, String endDate, OrderBy orderBy, Direction direction, Integer limit, Integer offset, String tags) throws AlgoliaRuntimeException
      (asynchronously) Returns the most popular of the latest 1,000 searches. For each search, also returns the number of hits.
      Parameters:
      index - Index name to target. (required)
      clickAnalytics - Whether to include [click and conversion](https://www.algolia.com/doc/guides/sending-events/getting-started/) rates for a search. (optional, default to false)
      startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      orderBy - Reorder the results. (optional, default to searchCount)
      direction - Sorting direction of the results: ascending or descending. (optional, default to asc)
      limit - Number of records to return (page size). (optional, default to 10)
      offset - Position of the starting record. Used for paging. 0 is the first record. (optional, default to 0)
      tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getTopSearchesAsync

      public CompletableFuture<GetTopSearchesResponse> getTopSearchesAsync(String index, RequestOptions requestOptions) throws AlgoliaRuntimeException
      (asynchronously) Returns the most popular of the latest 1,000 searches. For each search, also returns the number of hits.
      Parameters:
      index - Index name to target. (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(String index) throws AlgoliaRuntimeException
      (asynchronously) Returns the most popular of the latest 1,000 searches. For each search, also returns the number of hits.
      Parameters:
      index - Index name to target. (required)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getUsersCount

      public GetUsersCountResponse getUsersCount(String index, String startDate, String endDate, String tags, RequestOptions requestOptions) throws AlgoliaRuntimeException
      Return the count of unique users.
      Parameters:
      index - Index name to target. (required)
      startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (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(String index, String startDate, String endDate, String tags) throws AlgoliaRuntimeException
      Return the count of unique users.
      Parameters:
      index - Index name to target. (required)
      startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getUsersCount

      public GetUsersCountResponse getUsersCount(String index, RequestOptions requestOptions) throws AlgoliaRuntimeException
      Return the count of unique users.
      Parameters:
      index - Index name to target. (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(String index) throws AlgoliaRuntimeException
      Return the count of unique users.
      Parameters:
      index - Index name to target. (required)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getUsersCountAsync

      public CompletableFuture<GetUsersCountResponse> getUsersCountAsync(String index, String startDate, String endDate, String tags, RequestOptions requestOptions) throws AlgoliaRuntimeException
      (asynchronously) Return the count of unique users.
      Parameters:
      index - Index name to target. (required)
      startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (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(String index, String startDate, String endDate, String tags) throws AlgoliaRuntimeException
      (asynchronously) Return the count of unique users.
      Parameters:
      index - Index name to target. (required)
      startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze. (optional)
      tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded. (optional)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • getUsersCountAsync

      public CompletableFuture<GetUsersCountResponse> getUsersCountAsync(String index, RequestOptions requestOptions) throws AlgoliaRuntimeException
      (asynchronously) Return the count of unique users.
      Parameters:
      index - Index name to target. (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(String index) throws AlgoliaRuntimeException
      (asynchronously) Return the count of unique users.
      Parameters:
      index - Index name to target. (required)
      Throws:
      AlgoliaRuntimeException - If it fails to process the API call

    • post

      public Object post(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

    • post

      public Object post(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

    • post

      public Object post(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

    • post

      public Object post(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

    • postAsync

      public CompletableFuture<Object> postAsync(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

    • postAsync

      public CompletableFuture<Object> postAsync(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

    • postAsync

      public CompletableFuture<Object> postAsync(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

    • postAsync

      public CompletableFuture<Object> postAsync(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

    • put

      public Object put(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

    • put

      public Object put(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

    • put

      public Object put(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

    • put

      public Object put(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

    • putAsync

      public CompletableFuture<Object> putAsync(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

    • putAsync

      public CompletableFuture<Object> putAsync(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

    • putAsync

      public CompletableFuture<Object> putAsync(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

    • putAsync

      public CompletableFuture<Object> putAsync(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