One value of a faceted field with its match count. For hierarchical fields, returns an entry per hierarchy level and nests child levels under values. Other fields omit hierarchical properties.
Example
{
"value": "fiction",
"count": 87,
"label": "Fiction"
}
Properties
valueany
The facet value in its stored format: a string, boolean, number, or ISO 8601 timestamp string. For a hierarchical field, returns the label of the current level.
Example
"fiction"
countinteger
Number of matching documents containing this value.
Format
int64
Example
87
labelstring
The label the search settings of the index declare for the value, in the locale of the search, falling back to the field's default locale. Omitted when the settings declare no label for the value. See Field settings.
Example
"Fiction"
pathstring
The full path to the level, used in under filter matchers. Omitted for non-hierarchical fields.
Child hierarchy levels with their counts, evaluated up to depth levels below the current path. Omitted at the maximum counted depth and for non-hierarchical fields.
Example
{
"value": "fiction",
"count": 87,
"label": "Fiction"
}
totalValuesinteger
Total count of distinct child values below this level. Counts values, not documents. Exceeds the number of entries under values when the limit is reached, and no count covers the values left out. Omitted for non-hierarchical fields.
Format
int32
Endpoints
Endpoints where the request or responses uses this type.