Get message

Get message

(asynchronously) Retrieves metrics related to your Algolia infrastructure, aggregated over a selected time window. Access to this API is available as

(asynchronously) Retrieves metrics related to your Algolia infrastructure, aggregated over a selected time window. Access to this API is available as

A/B test name.

(asynchronously) Retrieves the fraction of searches that didn't lead to any click within a time range, including a daily breakdown. It also returns th

(asynchronously) Retrieves the fraction of searches that didn't lead to any click within a time range, including a daily breakdown. It also returns th

(asynchronously) Retrieves the fraction of searches that didn't return any results within a time range, including a daily breakdown. It also returns t

(asynchronously) Retrieves the fraction of searches that didn't return any results within a time range, including a daily breakdown. It also returns t

(asynchronously) Retrieves one record by its object ID. To retrieve more than one record, use the [`objects` operation](https://www.algolia.com/doc/re

(asynchronously) Retrieves one record by its object ID. To retrieve more than one record, use the [`objects` operation](https://www.algolia.com/doc/re

(asynchronously) Retrieves one or more records, potentially from different indices. Records are returned in the same order as the requests. @param ge

(asynchronously) Retrieves one or more records, potentially from different indices. Records are returned in the same order as the requests. @param ge

Position of the first hit to retrieve.

Returns a suitable OkHttpClient instance based on the provided request options.

(asynchronously) Beta : this endpoint is under active development and may change without notice. Returns the static catalog of analytics fields, gro

(asynchronously) Beta : this endpoint is under active development and may change without notice. Returns the static catalog of analytics fields, gro

(asynchronously) Retrieves the current personalization strategy. @param requestOptions The requestOptions to send along with the query, they will be

(asynchronously) Retrieves the current personalization strategy. @param requestOptions The requestOptions to send along with the query, they will be

(asynchronously) Get Provider. @param providerId The providerId. (required) @param requestOptions The requestOptions to send along with the query, th

(asynchronously) Get Provider. @param providerId The providerId. (required) @param requestOptions The requestOptions to send along with the query, th

(asynchronously) Retrieves the purchase rate for all your searches with at least one purchase event, including a daily breakdown. By default, the anal

(asynchronously) Retrieves the purchase rate for all your searches with at least one purchase event, including a daily breakdown. By default, the anal

(asynchronously) Test whether clusters are reachable or not. @param clusters Subset of clusters, separated by commas. (required) @param requestOption

(asynchronously) Test whether clusters are reachable or not. @param clusters Subset of clusters, separated by commas. (required) @param requestOption

(asynchronously) Retrieves a Recommend rule that you previously created in the Algolia dashboard. @param indexName Name of the index on which to perf

(asynchronously) Retrieves a Recommend rule that you previously created in the Algolia dashboard. @param indexName Name of the index on which to perf

(asynchronously) Checks the status of a given task. Deleting a Recommend rule is asynchronous. When you delete a rule, a task is created on a queue an

(asynchronously) Checks the status of a given task. Deleting a Recommend rule is asynchronous. When you delete a rule, a task is created on a queue an

(asynchronously) Retrieves recommendations from selected AI models. @param getRecommendationsParams (required) @param requestOptions The requestOptio

(asynchronously) Retrieves recommendations from selected AI models. @param getRecommendationsParams (required) @param requestOptions The requestOptio

Allowed HTTP referrers for this API key. By default, all referrers are allowed. You can use leading and trailing wildcard characters (` `): - `https:/

Get region

Index names or patterns that this API key can access. By default, an API key can access all indices in the same application. You can use leading and t

IP network that are allowed to use this key. You can only add a single source, but you can provide a range of IP addresses. Use this to protect agains

(asynchronously) Retrieves revenue-related metrics, such as the total revenue or the average order value. To retrieve revenue-related metrics, send pu

(asynchronously) Retrieves revenue-related metrics, such as the total revenue or the average order value. To retrieve revenue-related metrics, send pu

(asynchronously) Retrieves a rule by its ID. To find the object ID of a rule, use the [`search` operation](https://www.algolia.com/doc/rest-api/compos

(asynchronously) Retrieves a rule by its ID. To find the object ID of rules, use the [`search` operation](https://www.algolia.com/doc/rest-api/search/

(asynchronously) Retrieves a rule by its ID. To find the object ID of a rule, use the [`search` operation](https://www.algolia.com/doc/rest-api/compos

(asynchronously) Retrieves a rule by its ID. To find the object ID of rules, use the [`search` operation](https://www.algolia.com/doc/rest-api/search/

(asynchronously) Retrieve a single task run by its ID. @param runID Unique identifier of a task run. (required) @param requestOptions The requestOpti

Universally unique identifier (UUID) of a task run.

(asynchronously) Retrieve a single task run by its ID. @param runID Unique identifier of a task run. (required) @param requestOptions The requestOpti

Get searchParams

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

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

(asynchronously) Retrieves the most popular searches that didn't lead to any clicks, from the 1,000 most frequent searches. For each search, it also r

(asynchronously) Retrieves the most popular searches that didn't lead to any clicks, from the 1,000 most frequent searches. For each search, it also r

(asynchronously) Retrieves the 1,000 most frequent searches that produced zero results. @param index Index name. (required) @param startDate Start da

(asynchronously) Retrieves the 1,000 most frequent searches that produced zero results. @param index Index name. (required) @param startDate Start da

(asynchronously) Get Secret Key. @param secretKeyId The secretKeyId. (required) @param requestOptions The requestOptions to send along with the query

(asynchronously) Get Secret Key. @param secretKeyId The secretKeyId. (required) @param requestOptions The requestOptions to send along with the query

(asynchronously) Retrieves the servers that belong to clusters. The response depends on whether you authenticate your API request: - With authenticati

(asynchronously) Retrieves the servers that belong to clusters. The response depends on whether you authenticate your API request: - With authenticati

Retrieves an object with non-null index settings. @param indexName Name of the index on which to perform the operation. (required) @param getVersion

(asynchronously) Retrieves an object with non-null index settings. @param indexName Name of the index on which to perform the operation. (required) @

(asynchronously) Retrieves an object with non-null index settings. @param indexName Name of the index on which to perform the operation. (required) @

(asynchronously) Retrieve a source by its ID. @param sourceID Unique identifier of a source. (required) @param requestOptions The requestOptions to s

(asynchronously) Retrieve a source by its ID. @param sourceID Unique identifier of a source. (required) @param requestOptions The requestOptions to s

(asynchronously) Retrieves all allowed IP addresses with access to your application. @param requestOptions The requestOptions to send along with the

(asynchronously) Retrieves all allowed IP addresses with access to your application. @param requestOptions The requestOptions to send along with the

(asynchronously) Retrieves the status of all Algolia clusters and instances. @param requestOptions The requestOptions to send along with the query, t

(asynchronously) Retrieves the time when the Analytics data for the specified index was last updated. If the index has been recently created or no sea

(asynchronously) Retrieves the status of all Algolia clusters and instances. @param requestOptions The requestOptions to send along with the query, t

(asynchronously) Retrieves the time when the Analytics data for the specified index was last updated. If the index has been recently created or no sea

(asynchronously) Retrieves a synonym by its ID. To find the object IDs for your synonyms, use the [`search` operation](https://www.algolia.com/doc/res

(asynchronously) Retrieves a synonym by its ID. To find the object IDs for your synonyms, use the [`search` operation](https://www.algolia.com/doc/res

Checks the status of a given task. Indexing tasks are asynchronous. When you add, update, or delete records or indices, a task is created on a queue a

(asynchronously) Checks the status of a given task. @param compositionID Unique Composition ObjectID. (required) @param taskID Unique task identifier

(asynchronously) Checks the status of a given task. Indexing tasks are asynchronous. When you add, update, or delete records or indices, a task is cre

(asynchronously) Retrieves a task by its ID. @param taskID Unique identifier of a task. (required) @param requestOptions The requestOptions to send a

Universally unique identifier (UUID) of a task.

(asynchronously) Retrieves a task by its ID using the v1 endpoint. Use `getTask` instead. @param taskID Unique identifier of a task. (required) @para

(asynchronously) Retrieves a task by its ID using the v1 endpoint. Use `getTask` instead. @param taskID Unique identifier of a task. (required) @para

(asynchronously) Checks the status of a given task. @param compositionID Unique Composition ObjectID. (required) @param taskID Unique task identifier

(asynchronously) Checks the status of a given task. Indexing tasks are asynchronous. When you add, update, or delete records or indices, a task is cre

(asynchronously) Retrieves a task by its ID. @param taskID Unique identifier of a task. (required) @param requestOptions The requestOptions to send a

(asynchronously) Retrieves timeseries for an A/B test by its ID. @param id Unique A/B test identifier. (required) @param startDate Start date of the

(asynchronously) Retrieves timeseries for an A/B test by its ID. @param id Unique A/B test identifier. (required) @param startDate Start date of the

(asynchronously) Retrieves the countries with the most searches in your index. @param index Index name. (required) @param startDate Start date of the

(asynchronously) Retrieves the countries with the most searches in your index. @param index Index name. (required) @param startDate Start date of the

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

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

(asynchronously) Retrieves the 1,000 most frequent filter (facet) values for a filter attribute. These are attributes of your records that you include

(asynchronously) Retrieves the 1,000 most frequent filter (facet) values for a filter attribute. These are attributes of your records that you include

(asynchronously) Retrieves the 1,000 most frequently used filters for a search that didn't return any results. To get the most frequent searches witho

(asynchronously) Retrieves the 1,000 most frequently used filters for a search that didn't return any results. To get the most frequent searches witho

(asynchronously) Retrieves the object IDs of the 1,000 most frequent search results. If you set the `clickAnalytics` query parameter to `true`, the re

(asynchronously) Retrieves the object IDs of the 1,000 most frequent search results. If you set the `clickAnalytics` query parameter to `true`, the re

(asynchronously) Returns the most popular searches. For each search, it also includes the average number of hits. If you set the `clickAnalytics` quer

(asynchronously) Returns the most popular searches. For each search, it also includes the average number of hits. If you set the `clickAnalytics` quer

(asynchronously) Get the IDs of the 10 users with the highest number of records per cluster. Since it can take a few seconds to get the data from the