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 globally trending items.

Retrieve trending items for a specific facet.

Retrieve trending facet values for a specific facet attribute.

Retrieve recommendations.

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.

Add new objects to an index or replace existing objects with an updated set of attributes.

Update one or more attributes of an existing object.

Remove objects from an index using their objectID.

Clears all objects from your index and replaces them with a new set of objects.

Remove all objects matching a filter (including geo filters).

Clear the records of an index without affecting its settings.

Get one or more objects using their objectIDs.

Perform several indexing operations in one API call.

Get the settings of an index.

Create or 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.

Make a copy of an index, including its records, settings, Synonyms, and Rules except for the enableReRanking setting.

Get all index content without any record limit. Can be used for backups.

Renames an index. This is used internally to reindex your data without any downtime.

Returns whether an index exists or not.

Generate a secured API key without any call to our servers.

Add a new API Key with specific permissions/restrictions.

Replace every permission of an existing API key. Any unspecified field resets that permission to its default value.

Delete an existing API Key.

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

Get the permissions of an API key. When initializing the client using the admin API key, you can request information for any of your application’s API keys. When using a non-admin API key, you can only retrieve information for this specific API key.

Get the full list of API Keys.

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

Create or update a single synonym on an index.

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 using its object id.

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 single Rule.

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

Get the object/definition of a specific Rule.

Delete a specific Rule using its id.

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.

Retrieve an index’s full list of Rules using an iterator.

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

Send a click event to capture a query and its clicked items and positions.

Send a click event to capture clicked items.

Send a click event to capture the filters a user clicks on.

You can’t send these events for numeric filters.

Send a conversion event to capture a query and its clicked items.

Send a conversion event to capture clicked items.

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

Send a view event to capture viewed items.

A user browsing on a category page usually sees content filtered on that specific category. However, they haven’t clicked on or interacted with that filter. In scenarios where a user sees filtered content without interacting with that filter, you send view events.

Sending a view event captures the filters a user sees when viewing filtered content without having actively filtered it.

Send a batch of events.

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.

Enable or disable the use of standard dictionary entries

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.

Override the pre-configured timeouts.

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

Wait for a task to complete before executing the next line of code, to synchronize index updates.

Perform a custom request