Algolia icon

Algolia

Use Algolia in your n8n workflows

Actions27

Indices → Retrieve index settings

AI-generated

Overview

This node operation retrieves the settings of a specified Algolia index. It allows users to fetch detailed configuration data about an index, such as attributes for faceting, ranking criteria, and other search-related settings. This operation is useful for managing and auditing index configurations in Algolia, enabling users to understand or verify how their search indices are set up.

Use Case Examples

  1. A user wants to check the current settings of their 'products' index to ensure the correct attributes are set for faceting and ranking.
  2. An administrator needs to retrieve index settings to audit or document the configuration of multiple indices in their Algolia application.

Properties

Name Meaning
Index Name Name of the index on which to perform the operation. This is required to specify which index's settings to retrieve.
Simplify Whether to return a simplified version of the response instead of the raw data. When true, the response includes only key settings properties for easier consumption.
Options Additional options for the request, such as 'Get Version' which controls the version of the settings returned. For example, setting 'Get Version' to 2 excludes synonyms from the response for backward compatibility.

Output

JSON

  • advancedSyntax - Indicates if advanced syntax is enabled in the index settings.
  • advancedSyntaxFeatures - Features enabled under advanced syntax in the index settings.
  • allowCompressionOfIntegerArray - Whether integer array compression is allowed in the index settings.
  • allowTyposOnNumericTokens - Whether typos on numeric tokens are allowed in the index settings.
  • alternativesAsExact - Settings for treating plurals and synonyms as exact matches.
  • attributeCriteriaComputedByMinProximity - Whether attribute criteria are computed by minimum proximity.
  • attributeForDistinct - Attribute used for distinct grouping in search results.
  • attributesForFaceting - Attributes configured for faceting in the index.
  • attributesToHighlight - Attributes that are highlighted in search results.
  • attributesToRetrieve - Attributes that are retrieved in search results.

Dependencies

  • An API key credential for Algolia with permissions to read index settings.

Troubleshooting

  • Ensure the specified index name exists in the Algolia application; otherwise, the request will fail.
  • If the API key lacks permissions to read index settings, the request will be denied.
  • When using the simplify option, some detailed settings might be omitted, so verify if full data is needed.

Links

Discussion