API Methods

Set a personalization strategy.

Get the personalization strategy.

Retrieve frequently bought together items for a set of objectIDs.

Retrieve related products or related content for a set of objectIDs.

Retrieve global trending items.

Retrieve trending facet values for a specific facet attribute.

Retrieve similar looking recommendations for an objectID, based on image attributes.

Get recommendations from any Algolia recommendation model.

Method used for querying an index.

Search for a set of values within a given facet attribute. Can be combined with a query.

Perform a search on several indices at the same time, with one method call.

Find an object by the given condition. Can be used to debug relevance.

Retrieve the given object’s position in the given results set. Can be used to debug relevance.

Adds or replaces records.

Update one or more attributes of records.

Delete records from an index using their objectID.

Replace all records from your index with a new set of records.

Delete records matching a filter (including geo filters).

Clear the records of an index without affecting its settings.

Get one or more records using their object IDs.

Perform several indexing operations in one API call.

Retrieve index settings.

Change an index’s settings.

Copy the settings of an index to another index on the same app.

Get a list of indices with their associated metadata.

Delete an index and all its settings, including links to its replicas.

Copy an index, including its records, synonyms, rules, and settings.

Get all records from an index.

Move or rename an index.

Check if an index exists or not.

Generate a secured API key without any calls to Algolia’s servers.

Add a new API Key with specific permissions and restrictions.

Replace every permission of an existing API key.

Delete an API Key.

Restore a deleted API key, along with its associated rights.

Get the permissions of an API key.

Get a list of API keys.

Retrieve the remaining validity of a secured API key in seconds.

Add a synonym to an index or replace it.

Create or update multiple synonyms.

Remove a single synonym from an index using its object id.

Remove all synonyms from an index.

Get a single synonym object using its synonym ID (objectID).

Get all synonyms that match a query.

Push a new set of synonyms and erase all previous ones.

Copy the synonyms of an index to another index on the same app.

Retrieve an index’s complete list of synonyms.

Create or update a rule.

Create or update a specified set of Rules, or all Rules.

Get a rule by its objectID.

Delete a rule by its objectID.

Delete all Rules in an index.

Search for rules matching various criteria.

Push a new set of rules and erase all previous ones.

Copy the rules of an index to another index on the same app.

Get a list of all Rules defined on an index.

Create an A/B test.

Get an A/B test information and results.

List A/B tests information and results.

Stop an A/B test

Delete an A/B test

Initialize the Insights API client to communicate with the Algolia Insights API.

Send a click event related to an Algolia request.

Send a click event to capture clicked items.

Send a click event to capture when users select filters.

Send a conversion event related to an Algolia request.

Send a conversion event to capture clicked items.

Send a conversion event to capture the filters a user selected when converting.

Send a conversion event related to an Algolia request to capture when users add items to their shopping cart.

Send a conversion event to capture when users add items to their shopping cart.

Send a conversion event related to an Algolia request to capture when users purchase items.

Send a conversion event to capture when users purchase items.

Send a view event to capture viewed items.

Send a view event to capture the active filters for items a user viewed.

Send a list of events in a single request.

Set the anonymous user token for all subsequent events sent to the Algolia Insights API.

Get the anonymous user token from the Insights API Client state.

Set the authenticated user token for all subsequent events sent to the Algolia Insights API.

Get the authenticated user token from the Insights API Client state.

Add a custom user agent to the request.

Send a batch of entries to a dictionary.

Replace a batch of dictionary entries.

Delete a batch of dictionary entries.

Remove all words from a custom dictionary.

Search for entries in a dictionary.

Turn standard dictionary entries on or off.

Retrieve the dictionary override settings for plurals, stop words, and compound words.

Assign or Move a userID to a cluster.

Get the top 10 userIDs with the highest number of records per cluster.

Returns the userID data stored in the mapping.

List the clusters available in a multi-clusters setup for a single appID.

List the userIDs assigned to a multi-clusters appID.

Remove a userID and its associated data from the multi-clusters.

Search for userIDs.

Assign multiple userIDs to a cluster.

Get the status of your clusters’ migrations or user creations.

Get the logs of the latest search and indexing operations.

Change the pre-configured timeouts.

Send an extra HTTP header to Algolia for use with later queries.

Wait for a task to complete to ensure synchronized index updates.

Perform a custom request