Skip to main content
POST
Filter Field Values

Authorizations

x-api-key
string
header
required

Your Sixtyfour API key.

Body

application/json

Request for top values of a single field.

field
string
required

Canonical field path to aggregate values for.

Maximum string length: 200
mode
enum<string>
default:company

people or company.

Available options:
people,
company
top_k
integer
default:25

Maximum number of top values to return.

Required range: 1 <= x <= 100
filters
Filters · object | null

JSON query DSL that scopes the counts.

simple_filters
Simple Filters · object | null

Filters with Mongo-style operators that scope the counts.

Response

Successful Response

Top values response for one field.

field
string
required

Field requested by the caller.

canonical_field
string
required

Canonical field path used for aggregation.

value_type
string
required

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

supports_top_values
boolean
required

Whether this field supports top-values aggregation.

supports_exact_filter_snippet
boolean
required

Whether the response includes deterministic filter snippets.

total_scoped_documents
integer
required

Total documents matched by the scoped query.

mode
enum<string>
default:company

people or company.

Available options:
people,
company
nested_path
string | null

Nested path, if any.

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

preferred_for_exact_match
boolean
default:false

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

values
FilterFieldValuesValue · object[]

Top values ordered by count.