curl \
-X GET 'MEILISEARCH_URL/indexes/movies/settings/filterable-attributes' \
-H 'Authorization: Bearer API_KEY'client.index('movies').getFilterableAttributes()$client->index('movies')->getFilterableAttributes();client.index('movies').get_filterable_attributes()// Granular filterable attributes API (v1.14+)
client.index("movies").getGranularFilterableAttributesSettings();
// Legacy String[] API
client.index("movies").getFilterableAttributesSettings();client.index('movies').filterable_attributesclient.Index("movies").GetFilterableAttributes()IEnumerable<FilterableAttribute> attributes = await client.Index("movies").GetFilterableAttributesAsync();let filterable_attributes: Vec<String> = client
.index("movies")
.get_filterable_attributes()
.await
.unwrap();await client.index('movies').getFilterableAttributes();client.index("movies").getFilterableAttributes { (result) in
switch result {
case .success(let attributes):
print(attributes)
case .failure(let error):
print(error)
}
}[]{
"message": "The Authorization header is missing. It must use the bearer authorization method.",
"code": "missing_authorization_header",
"type": "auth",
"link": "https://docs.meilisearch.com/errors#missing_authorization_header"
}{
"message": "Index `movies` not found.",
"code": "index_not_found",
"type": "invalid_request",
"link": "https://docs.meilisearch.com/errors#index_not_found"
}Get filterableAttributes
Returns the current value of the filterableAttributes setting for the index.
curl \
-X GET 'MEILISEARCH_URL/indexes/movies/settings/filterable-attributes' \
-H 'Authorization: Bearer API_KEY'client.index('movies').getFilterableAttributes()$client->index('movies')->getFilterableAttributes();client.index('movies').get_filterable_attributes()// Granular filterable attributes API (v1.14+)
client.index("movies").getGranularFilterableAttributesSettings();
// Legacy String[] API
client.index("movies").getFilterableAttributesSettings();client.index('movies').filterable_attributesclient.Index("movies").GetFilterableAttributes()IEnumerable<FilterableAttribute> attributes = await client.Index("movies").GetFilterableAttributesAsync();let filterable_attributes: Vec<String> = client
.index("movies")
.get_filterable_attributes()
.await
.unwrap();await client.index('movies').getFilterableAttributes();client.index("movies").getFilterableAttributes { (result) in
switch result {
case .success(let attributes):
print(attributes)
case .failure(let error):
print(error)
}
}[]{
"message": "The Authorization header is missing. It must use the bearer authorization method.",
"code": "missing_authorization_header",
"type": "auth",
"link": "https://docs.meilisearch.com/errors#missing_authorization_header"
}{
"message": "Index `movies` not found.",
"code": "index_not_found",
"type": "invalid_request",
"link": "https://docs.meilisearch.com/errors#index_not_found"
}Authorizations
An API key is a token that you provide when making API calls. Read more about how to secure your project.
Include the API key to the Authorization header, for instance:
-H 'Authorization: Bearer 6436fc5237b0d6e0d64253fbaac21d135012ecf1'
If you use a SDK, ensure you instantiate the client with the API key, for instance with JS SDK:
const client = new MeiliSearch({ host: 'MEILISEARCH_URL', apiKey: '6436fc5237b0d6e0d64253fbaac21d135012ecf1' });
Path Parameters
Unique identifier of the index.
Response
Returns the current value of the filterableAttributes setting.
A rule declaring which attributes can be used for filtering and faceting.
A rule takes one of two forms. The object form lists attribute patterns together with the filtering and faceting features they enable. The string form names a single attribute and is a shorthand for an object matching that attribute with the default features.
Patterns to match attribute names. Use * as a wildcard to match any
characters. For example, ["price_*", "stock"] matches price_usd,
price_eur, and stock.
The filtering and faceting features enabled for attributes matching these patterns. If not specified, defaults to equality filtering enabled.
Show child attributes
Show child attributes
Was this page helpful?