Actions52
- Advanced Actions
- Api Keys Actions
- Clusters Actions
- Dictionaries Actions
- Indices Actions
- Records Actions
- Rules Actions
- Search Actions
- Synonyms Actions
- Vaults Actions
Overview
The Algolia "Search" node with the "Browse" operation allows users to retrieve records from a specified Algolia index. Unlike typical search queries that return ranked hits with highlighting and ranking details, the browse operation returns raw matching records up to 1,000 per request. This is particularly useful for exporting or iterating over all records in an index without the influence of typo tolerance, personalization, or other ranking features.
Common scenarios include:
- Exporting all records from an Algolia index for backup or migration.
- Iterating through records for bulk processing or analysis.
- Retrieving raw data without additional search metadata.
Example use case:
- A user wants to export all product records from their e-commerce index to synchronize with another system.
Properties
| Name | Meaning |
|---|---|
| Index Name | The name of the Algolia index to browse. Required. |
| Selector | Method to specify search parameters: either as a URL-encoded query string ("Search parameters as query string") or as individual options ("Option 2"). |
| Params | Search parameters provided as a URL-encoded query string (used if Selector is "search_parameters_as_query_string"). |
| Multiple properties | When Selector is "Option 2", this multi-select allows specifying which search parameters to include individually, such as Query, Filters, Facet Filters, Numeric Filters, Page, Hits Per Page, etc. |
| Query | The search query string to filter results. Optional. |
| Similar Query | Keywords used instead of the main query to perform a broader search. Optional. |
| Filters | Filter expression to restrict results based on attributes, numeric ranges, tags, or boolean filters. Optional. |
| Facet Filters | Filters applied on facets, can be provided as array or string. Optional. |
| Optional Filters | Filters that are optional, can be provided as array or string. Optional. |
| Numeric Filters | Numeric filters to apply, can be provided as array or string. Optional. |
| Tag Filters | Tag-based filters, can be provided as array or string. Optional. |
| Sum Or Filters Scores | Boolean indicating whether to sum all filter scores or keep the maximum. Optional. |
| Restrict Searchable Attributes | JSON array restricting the searchable attributes for the query. Optional. |
| Facets | JSON array of facets for which to retrieve facet values and counts. Optional. |
| Faceting After Distinct | Boolean indicating whether faceting should be applied after deduplication. Optional. |
| Page | Number of the page of results to retrieve (zero-based). Optional. |
| Offset | Position of the first hit to retrieve. Optional. |
| Length | Number of hits to retrieve starting from offset. Optional. |
| Around Lat Lng | Coordinates (latitude,longitude) to center geo-search. Optional. |
| Around Lat Lng Via IP | Boolean to obtain coordinates from request IP address. Optional. |
| Around Radius | Radius around the center point for geo-search; can be integer meters or "all". Optional. |
| Around Precision | Distance grouping precision for geo-ranking. Can be integer or range objects. Optional. |
| Minimum Around Radius | Minimum radius for geo-search when Around Radius isn't set. Optional. |
| Inside Bounding Box | Coordinates defining rectangular areas to restrict search. Can be string, null, or array. Optional. |
| Inside Polygon | Coordinates defining polygonal areas to restrict search. Optional. |
| Natural Languages | ISO language codes to adjust natural language processing settings. Optional. |
| Rule Contexts | Array of strings to assign rule contexts to the search query. Optional. |
| Personalization Impact | Number (0-100) indicating impact of personalization on ranking. Optional. |
| User Token | Unique user identifier for analytics and personalization. Optional. |
| Get Ranking Info | Boolean to include detailed ranking info in response. Optional. |
| Synonyms | Boolean to consider synonyms in search. Optional. |
| Click Analytics | Boolean to include queryID for click/conversion tracking. Optional. |
| Analytics | Boolean to include search in analytics. Optional. |
| Analytics Tags | JSON array of tags for segmenting analytics data. Optional. |
| Percentile Computation | Boolean to include search in processing-time percentile calculations. Optional. |
| Enable ABTest | Boolean to enable A/B testing for the search. Optional. |
| Attributes To Retrieve | JSON array of attributes to include in API response. Optional. |
| Ranking | JSON array defining custom ranking criteria. Optional. |
| Relevancy Strictness | Number threshold below which less relevant results are excluded. Optional. |
| Attributes To Highlight | JSON array of attributes to highlight in results. Optional. |
| Attributes To Snippet | JSON array of attributes for which to enable snippets. Optional. |
| Highlight Pre Tag | HTML tag inserted before highlighted parts. Optional. |
| Highlight Post Tag | HTML tag inserted after highlighted parts. Optional. |
| Snippet Ellipsis Text | String used as ellipsis indicator in snippets. Optional. |
| Restrict Highlight And Snippet Arrays | Boolean to restrict highlighting/snippeting to matched items only. Optional. |
| Hits Per Page | Number of hits per page. Optional. |
| Min Word Sizefor1Typo | Minimum word length to accept matches with one typo. Optional. |
| Min Word Sizefor2Typos | Minimum word length to accept matches with two typos. Optional. |
| Typo Tolerance | Typo tolerance setting; can be boolean or specific modes like "min" or "strict". Optional. |
| Allow Typos On Numeric Tokens | Boolean to allow typos on numeric tokens. Optional. |
| Disable Typo Tolerance On Attributes | JSON array of attributes to disable typo tolerance on. Optional. |
| Ignore Plurals | Setting to ignore plurals; can be boolean, string, or array. Optional. |
| Remove Stop Words | Setting to remove stop words; can be boolean or array of languages. Optional. |
| Query Languages | JSON array of languages for language-specific query processing. Optional. |
| Decompound Query | Boolean to split compound words into building blocks. Optional. |
| Enable Rules | Boolean to enable rules. Optional. |
| Enable Personalization | Boolean to enable personalization. Optional. |
| Query Type | Option to control prefix interpretation of query words: "prefixLast", "prefixAll", or "prefixNone". Optional. |
| Remove Words If No Results | Strategy for removing words if no results: "none", "lastWords", "firstWords", or "allOptional". Optional. |
| Mode | Search mode: "keywordSearch" or "neuralSearch". Optional. |
| Semantic Search | Settings object for semantic search part of NeuralSearch. Optional. |
| Advanced Syntax | Boolean to support phrase matching and excluding words. Optional. |
| Optional Words | List of optional words for the query. Optional. |
| Disable Exact On Attributes | JSON array of attributes to turn off exact ranking criterion. Optional. |
| Exact On Single Word Query | How exact ranking is computed for single-word queries: "attribute", "none", or "word". Optional. |
| Alternatives As Exact | JSON array determining which plurals and synonyms are considered exact matches. Optional. |
| Advanced Syntax Features | JSON array of advanced syntax features supported. Optional. |
| Distinct | Controls deduplication; can be boolean or integer. Optional. |
| Replace Synonyms In Highlight | Boolean to replace highlighted words with matched synonyms. Optional. |
| Min Proximity | Minimum proximity score for two matching words. Optional. |
| Response Fields | JSON array of properties to include in API response. Optional. |
| Max Values Per Facet | Maximum number of facet values to return per facet. Optional. |
| Sort Facet Values By | Order to retrieve facet values: "count" or "alpha". Optional. |
| Attribute Criteria Computed By Min Proximity | Boolean to determine best matching attribute by minimum proximity. Optional. |
| Rendering Content | Extra data for controlling UI aspects like facet ordering, redirects, widgets. Optional. |
| Enable Re Ranking | Boolean to enable Dynamic Re-Ranking. Optional. |
| Re Ranking Apply Filter | Filter applied during re-ranking; can be array, string, or null. Optional. |
| Cursor | Cursor string to get next page of results. Optional. |
Output
The node outputs the raw JSON response from the Algolia browse API call. This includes the list of records retrieved from the specified index according to the provided parameters.
The output json field contains:
- An array of records matching the browse criteria.
- Pagination information such as cursor or page details if applicable.
- No additional ranking or highlighting metadata is included since browse returns raw records.
The node does not output binary data.
Dependencies
- Requires an Algolia account with access to the specified application and indices.
- Requires an API key credential with appropriate permissions to perform browse operations on the selected index.
- The node uses the Algolia REST API endpoint for browsing (
POST /1/indexes/{indexName}/browse). - n8n credentials must provide the Algolia Application ID and API key.
Troubleshooting
- Invalid Index Name: If the specified index does not exist or is misspelled, the API will return an error. Verify the index name is correct.
- Permission Denied: Ensure the API key used has permission to browse the specified index.
- Too Many Records: Browse returns up to 1,000 records per request. Use pagination with the
cursorparameter to retrieve more. - Incorrect Parameter Format: Some parameters require JSON arrays or specific formats. Ensure inputs match expected types.
- Empty Results: If filters or queries are too restrictive, no records may be returned. Adjust parameters accordingly.
- API Rate Limits: Exceeding Algolia's rate limits will cause errors. Monitor usage and optimize queries.