Skip to main content
POST
/
search
/
filter-field-values
Filter Field Values
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": {}
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.sixtyfour.ai/llms.txt

Use this file to discover all available pages before exploring further.

Headers

x-api-key
string | null

Body

application/json

Request for top values of a single field.

field
string
required

Canonical field path to aggregate values for.

mode
enum<string>
default:company

Search mode: '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

Raw OpenSearch DSL filters that scope the aggregation.

simple_filters
Simple Filters · object

MongoDB-style filters that scope the aggregation.

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

Search mode: 'people' or 'company'.

Available options:
people,
company
aggregation_field
string | null

Underlying field used for the terms aggregation.

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.

request_duration_ms
integer | null

Server-side request duration in milliseconds.

values
FilterFieldValuesValue · object[]

Top values ordered by count.