* Retrieves an authentication resource by its ID. * * Resolves with the full HTTP response information: status code, headers (when the reque

* Retrieves the average click position of your search results, including a daily breakdown. The average click position is the average of all clicked

* Retrieves the average click position of your search results, including a daily breakdown. The average click position is the average of all clicked

* Retrieves the positions in the search results and their associated number of clicks. This lets you check how many clicks the first, second, or tent

* Retrieves the positions in the search results and their associated number of clicks. This lets you check how many clicks the first, second, or tent

* Retrieves the click-through rate (CTR) for all your searches with at least one click event, including a daily breakdown. By default, the analyzed p

* Retrieves the click-through rate (CTR) for all your searches with at least one click event, including a daily breakdown. By default, the analyzed p

* Retrieves known incidents for the selected clusters. * @param getClusterIncidents - The getClusterIncidents object. * @param getClusterInc

* Retrieves known incidents for the selected clusters. * * Resolves with the full HTTP response information: status code, headers (when the

* Retrieves the status of selected clusters. * @param getClusterStatus - The getClusterStatus object. * @param getClusterStatus.clusters - S

* Retrieves the status of selected clusters. * * Resolves with the full HTTP response information: status code, headers (when the requester

* Retrieve a single composition in the current Algolia application. * * Required API Key ACLs: * - editSettings * - settings

* Retrieve a single composition in the current Algolia application. * * Resolves with the full HTTP response information: status code, heade

* Retrieves a list of configuration objects for each index. * * Required API Key ACLs: * - search * - browse * - recommend

* Retrieves a single Query Suggestions configuration by its index name. * * Required API Key ACLs: * - settings * @param getConfi

* Reports the status of a Query Suggestions index. * * Required API Key ACLs: * - settings * @param getConfigStatus - The getConf

* Reports the status of a Query Suggestions index. * * Resolves with the full HTTP response information: status code, headers (when the requ

* Retrieves a list of configuration objects for each index. * * Resolves with the full HTTP response information: status code, headers (when

* Retrieves a single Query Suggestions configuration by its index name. * * Resolves with the full HTTP response information: status code, h

* Get Configuration. * * Required API Key ACLs: * - logs * @param requestOptions - The requestOptions to send along with the quer

* Get Configuration. * * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body

* Retrieves the conversation and its messages for the given ID. * * Required API Key ACLs: * - logs * @param getConversation - Th

* Retrieves the conversation and its messages for the given ID. * * Resolves with the full HTTP response information: status code, headers (

* Retrieves the conversion rate (CR) for all your searches with at least one conversion event, including a daily breakdown. By default, the analyzed

* Retrieves the conversion rate (CR) for all your searches with at least one conversion event, including a daily breakdown. By default, the analyzed

* Retrieves a destination by its ID. * * Required API Key ACLs: * - addObject * - deleteIndex * - editSettings * @par

* Retrieves a destination by its ID. * * Resolves with the full HTTP response information: status code, headers (when the requester captures

* Lists supported languages with their supported dictionary types and number of custom entries. * * Required API Key ACLs: * - setting

* Lists supported languages with their supported dictionary types and number of custom entries. * * Resolves with the full HTTP response inf

* Retrieves the languages for which standard dictionary entries are turned off. * * Required API Key ACLs: * - settings * @param

* Retrieves the languages for which standard dictionary entries are turned off. * * Resolves with the full HTTP response information: status

* Retrieves a single task run event by its ID. * * Required API Key ACLs: * - addObject * - deleteIndex * - editSettings

* Retrieves a single task run event by its ID. * * Resolves with the full HTTP response information: status code, headers (when the requeste

* Retrieves known incidents for all clusters. * @param requestOptions - The requestOptions to send along with the query, they will be merged with

* Retrieves known incidents for all clusters. * * Resolves with the full HTTP response information: status code, headers (when the requester

* Retrieves indexing latency metrics for selected clusters. This endpoint is intended for infrastructure-level monitoring and availability checks. Th

* Retrieves indexing latency metrics for selected clusters. This endpoint is intended for infrastructure-level monitoring and availability checks. Th

* Retrieves the average latency for search requests for selected clusters. * @param getLatency - The getLatency object. * @param getLatency.

* Retrieves the average latency for search requests for selected clusters. * * Resolves with the full HTTP response information: status code

* Retrieves the logs for a single Query Suggestions index. * * Required API Key ACLs: * - settings * @param getLogFile - The getL

* Retrieves the logs for a single Query Suggestions index. * * Resolves with the full HTTP response information: status code, headers (when

* The request must be authenticated by an API key with the [`logs` ACL](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl)

* The request must be authenticated by an API key with the [`logs` ACL](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl)

* Retrieves metrics related to your Algolia infrastructure, aggregated over a selected time window. Access to this API is available as part of the [P

* Retrieves metrics related to your Algolia infrastructure, aggregated over a selected time window. Access to this API is available as part of the [P

* Retrieves the fraction of searches that didn\'t lead to any click within a time range, including a daily breakdown. It also returns the number of tr

* Retrieves the fraction of searches that didn\'t lead to any click within a time range, including a daily breakdown. It also returns the number of tr

* Retrieves the fraction of searches that didn\'t return any results within a time range, including a daily breakdown. It also returns the count of se

* Retrieves the fraction of searches that didn\'t return any results within a time range, including a daily breakdown. It also returns the count of se

* Retrieves one record by its object ID. To retrieve more than one record, use the [`objects` operation](https://www.algolia.com/doc/rest-api/search/

* Retrieves one record by its object ID. To retrieve more than one record, use the [`objects` operation](https://www.algolia.com/doc/rest-api/search/

* Retrieves one or more records, potentially from different indices. Records are returned in the same order as the requests. * * Required A

* Retrieves one or more records, potentially from different indices. Records are returned in the same order as the requests. * * Resolves w

* **Beta**: this endpoint is under active development and may change without notice. Returns the static catalog of analytics fields, grouped by domai

* **Beta**: this endpoint is under active development and may change without notice. Returns the static catalog of analytics fields, grouped by domai

* Retrieves the current personalization strategy. * * Required API Key ACLs: * - recommendation * @param requestOptions - The req

* Retrieves the current personalization strategy. * * Resolves with the full HTTP response information: status code, headers (when the reque

* Get Provider. * * Required API Key ACLs: * - settings * @param getProvider - The getProvider object. * @param getProvider.

* Get Provider. * * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and

* Retrieves the purchase rate for all your searches with at least one purchase event, including a daily breakdown. By default, the analyzed period in

* Retrieves the purchase rate for all your searches with at least one purchase event, including a daily breakdown. By default, the analyzed period in

* Test whether clusters are reachable or not. * @param getReachability - The getReachability object. * @param getReachability.clusters - Sub

* Test whether clusters are reachable or not. * * Resolves with the full HTTP response information: status code, headers (when the requester

* Retrieves the real-time user\'s personalization profiles containing search filters. * * Required API Key ACLs: * - recommendation

* Retrieves the real-time user\'s personalization profiles containing search filters. * * Resolves with the full HTTP response information:

* Retrieves a Recommend rule that you previously created in the Algolia dashboard. * * Required API Key ACLs: * - settings * @par

* Retrieves a Recommend rule that you previously created in the Algolia dashboard. * * Resolves with the full HTTP response information: sta

* 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 and completed de

* 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 and completed de

* Retrieves recommendations from selected AI models. * * Required API Key ACLs: * - search * @param getRecommendationsParams - Th

* Retrieves recommendations from selected AI models. * * Required API Key ACLs: * - search * @param getRecommendationsParams - Th

* Retrieves recommendations from selected AI models. * * Resolves with the full HTTP response information: status code, headers (when the re

* Retrieves recommendations from selected AI models. * * Resolves with the full HTTP response information: status code, headers (when the re

* Retrieves revenue-related metrics, such as the total revenue or the average order value. To retrieve revenue-related metrics, send purchase events.

* Retrieves revenue-related metrics, such as the total revenue or the average order value. To retrieve revenue-related metrics, send purchase events.

* 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/search-rules).

* 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/composition/search-c

* 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/search-rules).

* 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/composition/search-c

* Retrieve a single task run by its ID. * * Required API Key ACLs: * - addObject * - deleteIndex * - editSettings * @

* Retrieve a single task run by its ID. * * Resolves with the full HTTP response information: status code, headers (when the requester captu

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

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

* Retrieves the most popular searches that didn\'t lead to any clicks, from the 1,000 most frequent searches. For each search, it also returns the nu

* Retrieves the most popular searches that didn\'t lead to any clicks, from the 1,000 most frequent searches. For each search, it also returns the nu

* Retrieves the 1,000 most frequent searches that produced zero results. * * Required API Key ACLs: * - analytics * @param getSea

* Retrieves the 1,000 most frequent searches that produced zero results. * * Resolves with the full HTTP response information: status code,

* Get Secret Key. * * Required API Key ACLs: * - settings * @param getSecretKey - The getSecretKey object. * @param getSecre

* Get Secret Key. * * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body an

* Retrieves the servers that belong to clusters. The response depends on whether you authenticate your API request: - With authentication, the respo

* Retrieves the servers that belong to clusters. The response depends on whether you authenticate your API request: - With authentication, the respo

* Retrieves an object with non-null index settings. * * Required API Key ACLs: * - settings * @param getSettings - The getSetting

* Retrieves an object with non-null index settings. * * Resolves with the full HTTP response information: status code, headers (when the req

* Retrieve a source by its ID. * * Required API Key ACLs: * - addObject * - deleteIndex * - editSettings * @param get

* Retrieve a source by its ID. * * Resolves with the full HTTP response information: status code, headers (when the requester captures them)

* Retrieves all allowed IP addresses with access to your application. * * Required API Key ACLs: * - admin * @param requestOption

* Retrieves all allowed IP addresses with access to your application. * * Resolves with the full HTTP response information: status code, hea

* Retrieves the time when the Analytics data for the specified index was last updated. If the index has been recently created or no search has been p

* Retrieves the status of all Algolia clusters and instances. * @param requestOptions - The requestOptions to send along with the query, they wil

* Retrieves the time when the Analytics data for the specified index was last updated. If the index has been recently created or no search has been p