v1

latestOpenAPI 3.1.0Proprietary2026-07-265759203.4 KB

Filter Field Values

Get the top values by count for a single filter-search field.

post/search/filter-field-values

x-api-keystring nullable

mode'people' | 'company'

Search mode: 'people' or 'company'.

fieldstring required

Canonical field path to aggregate values for.

top_kinteger

Maximum number of top values to return.

filtersobject nullable

Raw OpenSearch DSL filters that scope the aggregation.

simple_filtersobject nullable

MongoDB-style filters that scope the aggregation.

Successful Response

mode'people' | 'company'

Search mode: 'people' or 'company'.

fieldstring required

Field requested by the caller.

canonical_fieldstring required

Canonical field path used for aggregation.

aggregation_fieldstring nullable

Underlying field used for the terms aggregation.

nested_pathstring nullable

Nested path, if any.

value_typestring required

Aggregation target type (keyword, long, etc.).

supports_top_valuesboolean required

Whether this field supports top-values aggregation.

supports_exact_filter_snippetboolean required

Whether the response includes deterministic filter snippets.

related_fieldsstring[]

Other field paths representing the same concept (e.g. flat counterpart of nested).

preferred_for_exact_matchboolean

Recommended for simple exact-match queries over its nested counterpart.

total_scoped_documentsinteger required

Total documents matched by the scoped query.

request_duration_msinteger nullable

Server-side request duration in milliseconds.