Interface IFacetRequestValue

A currentValues item in a Search API facet request.



Optional children

children: IFacetRequestValue[]

The children of this category facet value. Each child is a full-fledged category facet value that may in turn have its own children and so forth, up to a maximum depth of 50 levels

Optional end

end: RangeType

The value to end the range at.


  • 500
  • 2018-12-31T23:59:59.999Z

Optional endInclusive

endInclusive: boolean

Whether to include the end value in the range.

Optional label

label: string

The label to associate with the range value.


  • 0 - 500
  • In 2018

Optional preventAutoSelect

preventAutoSelect: boolean

Whether to prevent Coveo ML from automatically selecting the facet value.

Default: false

Optional retrieveChildren

retrieveChildren: boolean

Whether to retrieve the children of this category facet value. Can only be used on leaf values in the request (i.e., values with no current children).

Default: false

Optional retrieveCount

retrieveCount: number

If retrieveChildren is true, the maximum number of children to retrieve for this leaf value.

Default (Search API): 0

Optional start

start: RangeType

The value to start the range at.


  • 0
  • 2018-01-01T00:00:00.000Z


The current facet value state in the search interface.

Default (Search API): idle

Optional value

value: string

Required (Search API). The facet value name.