* Deletes an A/B test by its ID. * * Required API Key ACLs: * - editSettings * @param deleteABTest - The deleteABTest object.

* Delete the specified agent. * * Required API Key ACLs: * - editSettings * @param deleteAgent - The deleteAgent object. * @

* Deletes the conversations matching the given filers. * * Required API Key ACLs: * - logs * @param deleteAgentConversations - Th

* Remove an allowed domain by id. * * Required API Key ACLs: * - editSettings * @param deleteAllowedDomain - The deleteAllowedDom

* Deletes the API key. * * Required API Key ACLs: * - admin * @param deleteApiKey - The deleteApiKey object. * @param delete

* Deletes an authentication resource. You can\'t delete authentication resources that are used by a source or a destination. * * Required AP

* This operation doesn\'t accept empty filters. This operation is resource-intensive. Use it only if you can\'t get the object IDs of the records you

* Delete a composition from the current Algolia application. * * Required API Key ACLs: * - editSettings * @param deleteCompositi

* Delete a Composition Rule from the specified Composition ID. * * Required API Key ACLs: * - editSettings * @param deleteComposi

* Deletes a Query Suggestions configuration. Deleting only removes the configuration and stops updates to the Query Suggestions index. To delete the

* Deletes the conversation with the given ID. * * Required API Key ACLs: * - logs * @param deleteConversation - The deleteConvers

* Deletes a destination by its ID. You can\'t delete destinations that are referenced in tasks. * * Required API Key ACLs: * - addObje

* Deletes an index and all its settings. - Deleting an index doesn\'t delete its analytics data. - If you try to delete a non-existing index, the ope

* Deletes a record by its object ID. To delete more than one record, use the [`batch` operation](https://www.algolia.com/doc/rest-api/search/batch).

* Helper: Deletes every records for the given objectIDs. The `chunkedBatch` helper is used under the hood, which creates a `batch` requests with at mo

* Delete Provider. * * Required API Key ACLs: * - editSettings * @param deleteProvider - The deleteProvider object. * @param

* Deletes a Recommend rule from a recommendation scenario. * * Required API Key ACLs: * - editSettings * @param deleteRecommendRu

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

* Delete Secret Key. * * Required API Key ACLs: * - admin * @param deleteSecretKey - The deleteSecretKey object. * @param de

* Deletes a source from the list of allowed sources. * * Required API Key ACLs: * - admin * @param deleteSource - The deleteSourc

* Deletes a source by its ID. You can\'t delete sources that are referenced in tasks. * * Required API Key ACLs: * - addObject *

* Deletes a synonym by its ID. To find the object IDs of your synonyms, use the [`search` operation](https://www.algolia.com/doc/rest-api/search/searc

* Deletes a task by its ID. * * Required API Key ACLs: * - addObject * - deleteIndex * - editSettings * @param delete

* Deletes a task by its ID using the v1 endpoint. Use `deleteTask` instead. * * Required API Key ACLs: * - addObject * - deleteI

* Deletes a transformation by its ID. * * Required API Key ACLs: * - addObject * - deleteIndex * - editSettings * @pa

* Deletes a user profile. * * Required API Key ACLs: * - search * - browse * - recommendation * @param deleteUser - T

* Permanently deletes all messages for the given user token. Does not delete conversations. * * Required API Key ACLs: * - logs *

* Deletes a user profile. The response includes a date and time when the user profile can safely be considered deleted. * * Required API Ke

* Deletes all events related to the specified user token from events metrics and analytics. The deletion is asynchronous, and processed within 48 hour

* Disables a task. * * Required API Key ACLs: * - addObject * - deleteIndex * - editSettings * @param disableTask - T

* Disables a task using the v1 endpoint. Use `disableTask` instead. * * Required API Key ACLs: * - addObject * - deleteIndex

* Enables a task. * * Required API Key ACLs: * - addObject * - deleteIndex * - editSettings * @param enableTask - The

* Enables a task using the v1 endpoint. Use `enableTask` instead. * * Required API Key ACLs: * - addObject * - deleteIndex

* Given the traffic percentage and the expected effect size, this endpoint estimates the sample size and duration of an A/B test based on historical t

* Given the traffic percentage and the expected effect size, this endpoint estimates the sample size and duration of an A/B test based on historical t

* Exports all conversations based on the passed filters. * * Required API Key ACLs: * - logs * @param exportConversations - The e

* Retrieves the details for an A/B test by its ID. * * Required API Key ACLs: * - analytics * @param getABTest - The getABTest ob

* Retrieves the details for an A/B test by its ID. * * Required API Key ACLs: * - analytics * @param getABTest - The getABTest ob

* Retrieves the add-to-cart rate for all your searches with at least one add-to-cart event, including a daily breakdown. By default, the analyzed per

* Retrieve details of the specified agent. * * Required API Key ACLs: * - settings * @param getAgent - The getAgent object.

* Retrieves all Query Suggestions configurations of your Algolia application. * * Required API Key ACLs: * - settings * @param re

* Get a single allowed domain by id. * * Required API Key ACLs: * - settings * @param getAllowedDomain - The getAllowedDomain obj

* Gets the permissions and restrictions of an API key. When authenticating with the admin API key, you can request information for any of your applic

* Checks the status of a given application task. * * Required API Key ACLs: * - editSettings * @param getAppTask - The getAppTask

* Retrieves an authentication resource by its ID. * * Required API Key ACLs: * - addObject * - deleteIndex * - editSetting

* 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 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 the status of selected clusters. * @param getClusterStatus - The getClusterStatus object. * @param getClusterStatus.clusters - S

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

* 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

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

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

* 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

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

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

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

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

* 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 logs for a single Query Suggestions index. * * Required API Key ACLs: * - settings * @param getLogFile - The getL

* 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 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 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 the current personalization strategy. * * Required API Key ACLs: * - recommendation * @param requestOptions - The req

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

* 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

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

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

* 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 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

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

* 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 1,000 most frequent searches that produced zero results. * * Required API Key ACLs: * - analytics * @param getSea

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

* 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