cat-field-data.md

layout	title	parent	nav_order	has_children	redirect_from
default	CAT field data	CAT API	15	false	/opensearch/rest-api/cat/cat-field-data/

CAT Field Data

Introduced 1.0 {: .label .label-purple }

The CAT Field Data operation lists the memory size used by each field per node.

Endpoints

GET /_cat/fielddata
GET /_cat/fielddata/{fields}

Query parameters

The following table lists the available query parameters. All query parameters are optional.

Parameter	Data type	Description	Default
bytes	String	The units used to display byte values.
format	String	A short version of the Accept header, such as json or yaml.
h	List	A comma-separated list of column names to display.
help	Boolean	Returns help information.	false
s	List	A comma-separated list of column names or column aliases to sort by.
v	Boolean	Enables verbose mode, which displays column headers.	false

Example requests

GET _cat/fielddata?v

{% include copy-curl.html %}

To limit the information to a specific field, add the field name after your query:

GET _cat/fielddata/<field_name>?v

{% include copy-curl.html %}

If you want to get information for more than one field, separate the field names with commas:

GET _cat/fielddata/field_name_1,field_name_2,field_name_3

{% include copy-curl.html %}

Example response

The following response shows the memory size for all fields as 284 bytes:

id                     host       ip         node       field size
1vo54NuxSxOrbPEYdkSF0w 172.18.0.4 172.18.0.4 odfe-node1 _id   284b
ZaIkkUd4TEiAihqJGkp5CA 172.18.0.3 172.18.0.3 odfe-node2 _id   284b