Skip to main content
  • Type: list<string>
  • Default: [](no excluded attributes)
  • Scope: settings
The unretrievableAttributes setting specifies attributes in your records to exclude from search results. This can help protect sensitive information, such as internal metrics or access controls, which may be used for ranking or filtering but shouldn’t be visible to end users.
There’s no hard limit on the number of attributes you can include, but adding too many can slow down getSettings operations and degrade performance in the Algolia dashboard.

​
Usage

  • Attribute names are case-sensitive.
  • This setting is ignored if the query is authenticated with the Admin API key.

​
Example

Current API clients

var response = await client.SetSettingsAsync(
  "ALGOLIA_INDEX_NAME",
  new IndexSettings { UnretrievableAttributes = new List<string> { "total_number_of_sales" } }
);

IndexSettings settings = new IndexSettings
{
  UnretrievableAttributes = new List { "total_number_of_sales" }
};

index.SetSettings(settings);
⌘I