API methods
Personalization
Add strategy |
Set a personalization strategy. |
Get strategy |
Get the personalization strategy. |
Recommend
Get frequently bought together |
Retrieve frequently bought together items for a set of |
Get related products |
Retrieve related products or related content for a set of |
Get trending items |
Retrieve global trending items. |
Get trending facets |
Retrieve trending facet values for a specific facet attribute. |
Get looking similar |
Retrieve similar looking recommendations for an |
Get recommendations |
Get recommendations from any Algolia recommendation model. |
Search
Search index |
Method used for querying an index. |
Search for facet values |
Search for a set of values within a given facet attribute. Can be combined with a query. |
Search multiple indices |
Perform a search on several indices at the same time, with one method call. |
Find Object |
Find an object by the given condition. Can be used to debug relevance. |
Get Object Position |
Retrieve the given object’s position in the given results set. Can be used to debug relevance. |
Indexing
Save objects |
Adds or replaces records. |
Partially update objects |
Update one or more attributes of records. |
Delete objects |
Delete records from an index using their |
Replace all objects |
Replace all records from your index with a new set of records. |
Delete by |
Delete records matching a filter (including geo filters). |
Clear objects |
Clear the records of an index without affecting its settings. |
Get objects |
Get one or more records using their object IDs. |
Custom batch |
Perform several indexing operations in one API call. |
Settings
Get settings |
Retrieve index settings. |
Set settings |
Change an index’s settings. |
Copy settings |
Copy the settings of an index to another index on the same app. |
Manage indices
List indices |
Get a list of indices with their associated metadata. |
Delete index |
Delete an index and all its settings, including links to its replicas. |
Copy index |
Copy an index, including its records, synonyms, rules, and settings. |
Browse index |
Get all records from an index. |
Move index |
Move or rename an index. |
Index exists |
Check if an index exists or not. |
API keys
Create secured API key |
Generate a secured API key without any calls to Algolia’s servers. |
Add API key |
Add a new API Key with specific permissions and restrictions. |
Update API key |
Replace every permission of an existing API key. |
Delete API key |
Delete an API Key. |
Restore API key |
Restore a deleted API key, along with its associated rights. |
Get API key permissions |
Get the permissions of an API key. |
List API keys |
Get a list of API keys. |
Get secured API key remaining validity |
Retrieve the remaining validity of a secured API key in seconds. |
Synonyms
Save synonym |
Add a synonym to an index or replace it. |
Save synonyms |
Create or update multiple synonyms. |
Delete synonym |
Remove a single synonym from an index using its object id. |
Clear all synonyms |
Remove all synonyms from an index. |
Get synonym |
Get a single synonym object using its synonym ID ( |
Search synonyms |
Get all synonyms that match a query. |
Replace all synonyms |
Push a new set of synonyms and erase all previous ones. |
Copy synonyms |
Copy the synonyms of an index to another index on the same app. |
Export Synonyms |
Retrieve an index’s complete list of synonyms. |
Rules
Save rule |
Create or update a rule. |
Batch Rules |
Create or update a specified set of Rules, or all Rules. |
Get Rule |
Get a rule by its |
Delete Rule |
Delete a rule by its |
Clear Rules |
Delete all Rules in an index. |
Search rules |
Search for rules matching various criteria. |
Replace all rules |
Push a new set of rules and erase all previous ones. |
Copy rules |
Copy the rules of an index to another index on the same app. |
Export Rules |
Get a list of all Rules defined on an index. |
A/B Test
Add A/B test |
Create an A/B test. |
Get A/B test |
Get an A/B test information and results. |
List A/B tests |
List A/B tests information and results. |
Stop A/B test |
Stop an A/B test |
Delete A/B test |
Delete an A/B test |
Insights
Init |
Initialize the Insights API client to communicate with the Algolia Insights API. |
Clicked object IDs after search |
Send a click event related to an Algolia request. |
Clicked object IDs |
Send a click event to capture clicked items. |
Clicked filters |
Send a click event to capture when users select filters. |
Converted object IDs after search |
Send a conversion event related to an Algolia request. |
Converted object IDs |
Send a conversion event to capture clicked items. |
Converted filters |
Send a conversion event to capture the filters a user selected when converting. |
Added to cart object IDs after search |
Send a conversion event related to an Algolia request to capture when users add items to their shopping cart. |
Added to cart object IDs |
Send a conversion event to capture when users add items to their shopping cart. |
Purchased object IDs after search |
Send a conversion event related to an Algolia request to capture when users purchase items. |
Purchased object IDs |
Send a conversion event to capture when users purchase items. |
Viewed object IDs |
Send a view event to capture viewed items. |
Viewed filters |
Send a view event to capture the active filters for items a user viewed. |
Send events |
Send a list of events in a single request. |
Set user token |
Set the anonymous user token for all subsequent events sent to the Algolia Insights API. |
Get user token |
Get the anonymous user token from the Insights API Client state. |
Set authenticated user token |
Set the authenticated user token for all subsequent events sent to the Algolia Insights API. |
Get authenticated user token |
Get the authenticated user token from the Insights API Client state. |
Add user agent |
Add a custom user agent to the request. |
Dictionaries
Save dictionary entries |
Send a batch of entries to a dictionary. |
Replace dictionary entries |
Replace a batch of dictionary entries. |
Delete dictionary entries |
Delete a batch of dictionary entries. |
Clear dictionary entries |
Remove all words from a custom dictionary. |
Search dictionary entries |
Search for entries in a dictionary. |
Set dictionary settings |
Turn standard dictionary entries on or off. |
Get dictionary settings |
Retrieve the dictionary override settings for plurals, stop words, and compound words. |
MultiClusters
Assign or Move userID |
Assign or Move a userID to a cluster. |
Get top userID |
Get the top 10 userIDs with the highest number of records per cluster. |
Get userID |
Returns the userID data stored in the mapping. |
List clusters |
List the clusters available in a multi-clusters setup for a single appID. |
List userIDs |
List the userIDs assigned to a multi-clusters appID. |
Remove userID |
Remove a userID and its associated data from the multi-clusters. |
Search userID |
Search for userIDs. |
Batch assign userIDs |
Assign multiple userIDs to a cluster. |
Has pending mappings |
Get the status of your clusters’ migrations or user creations. |
Advanced
Get logs |
Get the logs of the latest search and indexing operations. |
Configuring timeouts |
Change the pre-configured timeouts. |
Set extra header |
Send an extra HTTP header to Algolia for use with later queries. |
Wait for operations |
Wait for a task to complete to ensure synchronized index updates. |
Custom request |
Perform a custom request |