Displayed attributes

Child route of the settings route.

The fields whose attributes are added to the displayed-attributes list are displayed in each matching document.
By default, all fields are considered to be displayedAttributes. This behavior is represented by the * in the settings. Setting displayedAttributes to an empty array [] will reset the setting to its default value.

Displayed attributes can also be updated directly through the global settings route along with the other settings.

To learn more about displayed attributes, refer to our dedicated guide.

WARNING

Updating the settings means overwriting the default settings of Meilisearch. You can reset to default values using the DELETE routes.

Get displayed attributes

GET

/indexes/{index_uid}/settings/displayed-attributes

Get the displayed attributes of an index. The index uid is required.

Example

curl \
  -X GET 'http://localhost:7700/indexes/movies/settings/displayed-attributes'

client.index('movies').getDisplayedAttributes()

client.index('movies').get_displayed_attributes()

$client->index('movies')->getDisplayedAttributes();

client.index("movies").getDisplayedAttributes();

client.index('movies').get_displayed_attributes

client.Index("movies").GetDisplayedAttributes()

await client.Index("movies").GetDisplayedAttributesAsync();

let displayed_attributes: Vec<String> = client
  .index("movies")
  .get_displayed_attributes()
  .await
  .unwrap();

client.index("movies").getDisplayedAttributes { (result) in
    switch result {
    case .success(let displayedAttributes):
        print(displayedAttributes)
    case .failure(let error):
        print(error)
    }
}

await client.index('movies').getDisplayedAttributes();

Response: 200 Ok

List the settings.

[
  "title",
  "overview",
  "genres",
  "release_date.year"
]

Update displayed attributes

PUT

/indexes/{index_uid}/settings/displayed-attributes

Update the displayed attributes of an index. The index uid is required.

If an attribute contains an object, you can use dot notation to specify one or more of its keys, e.g., "displayedAttributes": ["release_date.year"].

NOTE

displayedAttributes only impacts search results. It has no effect on other methods of retrieving or copying documents, such as the GET documents endpoint, dumps, or snapshots.

Body

An array of strings that contains attributes of an index to display.

More information about the body.

Example

curl \
  -X PUT 'http://localhost:7700/indexes/movies/settings/displayed-attributes' \
  -H 'Content-Type: application/json' \
  --data-binary '[
    "title",
    "overview",
    "genres",
    "release_date"
  ]'

client.index('movies').updateDisplayedAttributes([
  'title',
  'overview',
  'genres',
  'release_date'
])

client.index('movies').update_displayed_attributes([
    'title',
    'overview',
    'genres',
    'release_date'
])

$client->index('movies')->updateDisplayedAttributes([
  'title',
  'overview',
  'genres',
  'release_date'
]);

client.index("movies").updateDisplayedAttributesSettings(new String[]
{
  "title",
  "overview",
  "genres",
  "release_date"
});

client.index('movies').update_displayed_attributes([
  'title',
  'overview',
  'genres',
  'release_date'
])

displayedAttributes := []string{
  "title",
  "overview",
  "genres",
  "release_date",
}
client.Index("movies").UpdateDisplayedAttributes(&displayedAttributes)

await client.Index("movies").UpdateDisplayedAttributesAsync(new[]
{
  "title",
  "overview",
  "genres",
  "release_date"
});

let displayed_attributes = [
  "title",
  "overview",
  "genres",
  "release_date"
];

let task: TaskInfo = client
  .index("movies")
  .set_displayed_attributes(&displayed_attributes)
  .await
  .unwrap();

let displayedAttributes: [String] = ["title", "overview", "genres", "release_date"]
client.index("movies").updateDisplayedAttributes(displayedAttributes) { (result) in
    switch result {
    case .success(let task):
        print(task)
    case .failure(let error):
        print(error)
    }
}

await client.index('movies').updateDisplayedAttributes([
  'title',
  'overview',
  'genres',
  'release_date'
]);

Response: 202 Accepted

{
    "taskUid": 1,
    "indexUid": "movies",
    "status": "enqueued",
    "type": "settingsUpdate",
    "enqueuedAt": "2021-08-11T09:25:53.000000Z"
}

You can use this taskUid to get more details on the status of the task.

Reset displayed attributes

DELETE

/indexes/{index_uid}/settings/displayed-attributes

Reset the displayed attributes of the index to the default value. The index uid is required.

Default value

All attributes found in the documents added to the index.

Example

curl \
  -X DELETE 'http://localhost:7700/indexes/movies/settings/displayed-attributes'

client.index('movies').resetDisplayedAttributes()

client.index('movies').reset_displayed_attributes()

$client->index('movies')->resetDisplayedAttributes();

client.index("movies").resetDisplayedAttributesSettings();

client.index('movies').reset_displayed_attributes

client.Index("movies").ResetDisplayedAttributes()

await client.Index("movies").ResetDisplayedAttributesAsync();

let task: TaskInfo = client
  .index("movies")
  .reset_displayed_attributes()
  .await
  .unwrap();

client.index("movies").resetDisplayedAttributes { (result) in
    switch result {
    case .success(let task):
        print(task)
    case .failure(let error):
        print(error)
    }
}

await client.index('movies').resetDisplayedAttributes();

Response: 202 Accepted

{
    "taskUid": 1,
    "indexUid": "movies",
    "status": "enqueued",
    "type": "settingsUpdate",
    "enqueuedAt": "2021-08-11T09:25:53.000000Z"
}

You can use this taskUid to get more details on the status of the task.