Algolia Browse

Learning how to use Aloglia browse on Interplay

Written By Brian Sathinathan (Super Administrator)

Updated at January 5th, 2021

Description

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

The browse method is an alternative to the Search index method. The search method cannot return more than 1,000 results. If you need to retrieve all the content of your index (for backup, SEO purposes or for running a script on it), you should use this method instead.

Results are ranked by attributes and custom ranking.

But for performance reasons, there is no ranking based on:

  • distinct
  • typo-tolerance
  • number of matched words
  • proximity
  • geo distance

Code For Above Flow

[{"id":"bc5e00bf.403a1","type":"algoliabrowse","z":"31563c97.599414","API_ID":"","API_Key":"","Index":"Product","name":"","x":260,"y":560,"wires":[["73e2642b.6a4b0c"]]},{"id":"bb736c03.0a35b","type":"inject","z":"31563c97.599414","name":"","topic":"","payload":"{\"name\": \"Pizza\", \"price\": \"10\", \"quantity\": \"7\"}","payloadType":"str","repeat":"","crontab":"","once":false,"onceDelay":0.1,"x":90,"y":560,"wires":[["bc5e00bf.403a1"]]},{"id":"73e2642b.6a4b0c","type":"console","z":"31563c97.599414","name":"","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"false","x":430,"y":560,"wires":[]}]

Input

payload (string)A string formatted as a JSON object to be searched for (Example: {“name”: “Pizza”, “price”: “10”, “quantity”: “7”}).

Parameters

API_ID (string)The users Application ID

API_Key (string)

The users Admin API Key

Index (string)

The index under which the JSON object that was passed through the payload will be searched under. (Must already exists or have been created by the user)

Output

payload (object)An object containing an array or matches that where found for the search.