Algolia

Algolia integration (Developer Tools, Data). Imported from open-connector.

API key9 toolshttps://{application_id}.algolia.net

GET

algolia_list_indices

List Algolia indices accessible to the current API key.

/1/indexes

2 parameters

Param	Type	Required	Description
page	integer	optional	The zero-based page number.
hitsPerPage	integer	optional	The number of hits to return per page.

POST

algolia_search_index

Search a single Algolia index with the most common search parameters.

/1/indexes/{indexName}/query

20 parameters

Param	Type	Required	Description
indexName	string	required	The Algolia index name.
query	string	optional	The search query string.
page	integer	optional	The zero-based page number.
hitsPerPage	integer	optional	The number of hits to return per page.
filters	string	optional	The filter expression using Algolia's SQL-like syntax.
facetFilters	string	optional	An Algolia filter expression in string or array form.
numericFilters	string	optional	An Algolia filter expression in string or array form.
tagFilters	string	optional	An Algolia filter expression in string or array form.
facets	array	optional	A list of non-empty strings.
attributesToRetrieve	array	optional	A list of non-empty strings.
attributesToHighlight	array	optional	A list of non-empty strings.
attributesToSnippet	array	optional	A list of non-empty strings.
aroundLatLng	string	optional	The geolocation point in `lat,lng` form.
aroundRadius	integer	optional	The geolocation radius restriction.
insideBoundingBox	string	optional	Bounding box coordinates used to restrict the search area.
insidePolygon	string	optional	Polygon coordinates used to restrict the search area.
clickAnalytics	boolean	optional	Whether to include click analytics information.
analytics	boolean	optional	Whether to send the search to Algolia analytics.
getRankingInfo	boolean	optional	Whether to include ranking information in the response.
sumOrFiltersScores	boolean	optional	Whether to sum OR filter scores instead of taking the maximum.

POST

algolia_browse_index

Browse records from a single Algolia index, optionally continuing with a cursor.

/1/indexes/{indexName}/browse

9 parameters

Param	Type	Required	Description
indexName	string	required	The Algolia index name.
cursor	string	optional	The cursor returned by the previous browse response.
query	string	optional	An optional browse query string.
filters	string	optional	The filter expression using Algolia's SQL-like syntax.
facetFilters	string	optional	An Algolia filter expression in string or array form.
numericFilters	string	optional	An Algolia filter expression in string or array form.
tagFilters	string	optional	An Algolia filter expression in string or array form.
attributesToRetrieve	array	optional	A list of non-empty strings.
hitsPerPage	integer	optional	The number of hits to return per page.

GET

algolia_get_record

Retrieve a single record from an Algolia index by objectID.

/1/indexes/{indexName}/{objectID}

3 parameters

Param	Type	Required	Description
indexName	string	required	The Algolia index name.
objectID	string	required	The Algolia record objectID.
attributesToRetrieve	array	optional	A list of non-empty strings.

PUT

algolia_add_or_replace_record

Add a new record or replace an existing Algolia record using its objectID.

/1/indexes/{indexName}/{objectID}

4 parameters

Param	Type	Required	Description
indexName	string	required	The Algolia index name.
record	object	required	The Algolia record payload.
forwardToReplicas	boolean	optional	Whether to forward the write operation to replicas.
objectID	string	required	Path parameter: objectID

POST

algolia_update_record_partially

Partially update an existing Algolia record by objectID.

/1/indexes/{indexName}/{objectID}/partial

5 parameters

Param	Type	Required	Description
indexName	string	required	The Algolia index name.
objectID	string	required	The Algolia record objectID.
attributesToUpdate	object	required	The partial Algolia record attributes to update.
createIfNotExists	boolean	optional	Whether to create the record if it doesn't exist.
forwardToReplicas	boolean	optional	Whether to forward the write operation to replicas.

POST

algolia_delete_records_by_filter

Delete Algolia records that match a filter expression.

/1/indexes/{indexName}/deleteByQuery

2 parameters

Param	Type	Required	Description
indexName	string	required	The Algolia index name.
filters	string	optional	The filter expression used to select records to delete.

PUT

algolia_save_rule

Save a single Algolia rule by objectID.

/1/indexes/{indexName}/rules/{objectID}

4 parameters

Param	Type	Required	Description
indexName	string	required	The Algolia index name.
rule	object	required	The Algolia rule payload.
forwardToReplicas	boolean	optional	Whether to forward the write operation to replicas.
objectID	string	required	Path parameter: objectID

PUT

algolia_save_synonym

Save a single Algolia synonym by objectID.

/1/indexes/{indexName}/synonyms/{objectID}

4 parameters

Param	Type	Required	Description
indexName	string	required	The Algolia index name.
synonym	object	required	The Algolia synonym payload.
forwardToReplicas	boolean	optional	Whether to forward the write operation to replicas.
objectID	string	required	Path parameter: objectID