Field Capabilities API
editField Capabilities API
editAllows you to retrieve the capabilities of fields among multiple indices.
GET /_field_caps?fields=rating
Description
editThe field capabilities API returns the information about the capabilities of fields among multiple indices.
Path parameters
edit-
<index>
- (Optional, string) Comma-separated list or wildcard expression of index names used to limit the request.
Query parameters
edit-
allow_no_indices
-
(Optional, boolean) If
true
, the request does not return an error if a wildcard expression or_all
value retrieves only missing or closed indices.This parameter also applies to index aliases that point to a missing or closed index.
-
expand_wildcards
-
(Optional, string) Controls what kind of indices that wildcard expressions can expand to. Valid values are:
-
all
- Expand to open and closed indices.
-
open
- Expand only to open indices.
-
closed
- Expand only to closed indices.
-
none
- Wildcard expressions are not accepted.
Defaults to
open
. -
-
fields
-
(Optional, string) Comma-separated list or wildcard expressions of fields to include in the statistics.
Used as the default list unless a specific field list is provided in the
completion_fields
orfielddata_fields
parameters. -
ignore_unavailable
-
(Optional, boolean) If
true
, missing or closed indices are not included in the response. Defaults tofalse
. -
include_unmapped
-
(Optional, boolean) If
true
, unmapped fields are included in the response. Defaults tofalse
.
Response body
edit-
searchable
- Whether this field is indexed for search on all indices.
-
aggregatable
- Whether this field can be aggregated on all indices.
-
indices
- The list of indices where this field has the same type, or null if all indices have the same type for the field.
-
non_searchable_indices
- The list of indices where this field is not searchable, or null if all indices have the same definition for the field.
-
non_aggregatable_indices
- The list of indices where this field is not aggregatable, or null if all indices have the same definition for the field.
Examples
editThe request can be restricted to specific indices:
GET twitter/_field_caps?fields=rating
The next example API call requests information about the rating
and the
title
fields:
GET _field_caps?fields=rating,title
The API returns the following response:
{ "indices": ["index1", "index2", "index3", "index4", "index5"], "fields": { "rating": { "long": { "searchable": true, "aggregatable": false, "indices": ["index1", "index2"], "non_aggregatable_indices": ["index1"] }, "keyword": { "searchable": false, "aggregatable": true, "indices": ["index3", "index4"], "non_searchable_indices": ["index4"] } }, "title": { "text": { "searchable": true, "aggregatable": false } } } }
The field |
|
The field |
|
The field |
|
The field |
By default unmapped fields are ignored. You can include them in the response by
adding a parameter called include_unmapped
in the request:
GET _field_caps?fields=rating,title&include_unmapped
In which case the response will contain an entry for each field that is present in some indices but not all:
{ "indices": ["index1", "index2", "index3"], "fields": { "rating": { "long": { "searchable": true, "aggregatable": false, "indices": ["index1", "index2"], "non_aggregatable_indices": ["index1"] }, "keyword": { "searchable": false, "aggregatable": true, "indices": ["index3", "index4"], "non_searchable_indices": ["index4"] }, "unmapped": { "indices": ["index5"], "searchable": false, "aggregatable": false } }, "title": { "text": { "indices": ["index1", "index2", "index3", "index4"], "searchable": true, "aggregatable": false }, "unmapped": { "indices": ["index5"] "searchable": false, "aggregatable": false } } } }