curl --request POST \
--url https://api.sixtyfour.ai/search/filter-field-values \
--header 'Content-Type: application/json' \
--data '
{
"field": "<string>",
"mode": "company",
"top_k": 25,
"filters": {},
"simple_filters": {}
}
'{
"field": "<string>",
"canonical_field": "<string>",
"value_type": "<string>",
"supports_top_values": true,
"supports_exact_filter_snippet": true,
"total_scoped_documents": 123,
"mode": "company",
"aggregation_field": "<string>",
"nested_path": "<string>",
"related_fields": [
"<string>"
],
"preferred_for_exact_match": false,
"request_duration_ms": 123,
"values": [
{
"count": 123,
"percent_of_scope": 123,
"value": "<string>",
"filter_snippet": {}
}
]
}Filter Field Values
Get the top values by count for a single filter-search field.
curl --request POST \
--url https://api.sixtyfour.ai/search/filter-field-values \
--header 'Content-Type: application/json' \
--data '
{
"field": "<string>",
"mode": "company",
"top_k": 25,
"filters": {},
"simple_filters": {}
}
'{
"field": "<string>",
"canonical_field": "<string>",
"value_type": "<string>",
"supports_top_values": true,
"supports_exact_filter_snippet": true,
"total_scoped_documents": 123,
"mode": "company",
"aggregation_field": "<string>",
"nested_path": "<string>",
"related_fields": [
"<string>"
],
"preferred_for_exact_match": false,
"request_duration_ms": 123,
"values": [
{
"count": 123,
"percent_of_scope": 123,
"value": "<string>",
"filter_snippet": {}
}
]
}Headers
Body
Request for top values of a single field.
Canonical field path to aggregate values for.
Search mode: 'people' or 'company'.
people, company Maximum number of top values to return.
1 <= x <= 100Raw OpenSearch DSL filters that scope the aggregation.
MongoDB-style filters that scope the aggregation.
Response
Successful Response
Top values response for one field.
Field requested by the caller.
Canonical field path used for aggregation.
Aggregation target type (keyword, long, etc.).
Whether this field supports top-values aggregation.
Whether the response includes deterministic filter snippets.
Total documents matched by the scoped query.
Search mode: 'people' or 'company'.
people, company Underlying field used for the terms aggregation.
Nested path, if any.
Other field paths representing the same concept (e.g. flat counterpart of nested).
Recommended for simple exact-match queries over its nested counterpart.
Server-side request duration in milliseconds.
Top values ordered by count.
Show child attributes
Show child attributes
Was this page helpful?