|Add strategy|| |
Set a personalization strategy for your application
|Get strategy|| |
Get the personalization strategy for your application
|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.
|Browse index|| |
Get all index content without any record limit. Can be used for backups.
|Add objects|| |
Add new objects to an index.
|Save objects|| |
Replace an existing object with an updated set of attributes.
|Partial update objects|| |
Update one or more attributes of an existing object.
|Delete objects|| |
Remove objects from an index using their object ids.
|Replace all objects|| |
Push a new set of objects and remove all previous ones. Settings, synonyms and query rules are untouched.
|Delete by|| |
Remove all objects matching a filter (including geo filters).
|Clear objects|| |
Clear the records of an index without affecting its settings.
|Get objects|| |
Get one or more objects using their object ids.
|Custom batch|| |
Perform several indexing operations in one API call.
|Get settings|| |
Get the settings of an index.
|Set settings|| |
Create or change an index’s settings.
|Copy settings|| |
Copy the settings of an index to another index on the same app.
|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|| |
Make a copy of an index, including its objects, settings, synonyms, and query rules.
|Move index|| |
Rename an index. Normally used to reindex your data atomically, without any down time.
|Create secured API Key|| |
Generate a virtual API Key without any call to the server.
|Add API Key|| |
Add a new API Key with specific permissions/restrictions.
|Update API Key|| |
Update the permissions of an existing API Key.
|Delete API Key|| |
Delete an existing API Key.
|Get API Key permissions|| |
Get the permissions of an API Key.
|List API Keys|| |
Get the full list of API Keys.
|Save synonym|| |
Create or update a single synonym on an index.
|Batch 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 using its object 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.
|Save rule|| |
Create or update a single rule.
|Batch rules|| |
Create or update a specified set of rules, or all rules.
|Get rule|| |
Get the object/definition of a specific rule.
|Delete rule|| |
Delete a specific rule using its id.
|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|| |
Retrieve an index’s full list of rules using an iterator.
|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
|Clicked Object IDs After Search|| |
Send an click event related to a search query and to one or more objectID.
|Clicked Object IDs|| |
Send a click event related to one or more objectID.
|Clicked Filters|| |
Send a click event related to one or more filters.
|Converted Objects IDs After Search|| |
Send an conversion event related to a search query and to one or more objectID.
|Converted Object IDs|| |
Send a conversion event related to one or more objectID.
|Converted Filters|| |
Send a conversion event related to one or more filters.
|Viewed Object IDs|| |
Send a view event related to one or more objectID.
|Viewed Filters|| |
Send a view event related to one or more filters.
|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.
|Get logs|| |
Get the logs of the latest search and indexing operations.
|Configuring timeouts|| |
Override the pre-configured timeouts.
|Set extra header|| |
Sends an extra http header to Algolia, for all subsequent queries.
|Wait for operations|| |
Wait for a task to complete before executing the next line of code, to synchronize index updates.