The Open API specification for Synapse is now available for download!

Download Open API Spec

TermsAggregation

org.sagebionetworks.repo.model.search.dsl.TermsAggregation

A terms bucket aggregation — one bucket per distinct value of field.

Field Type Description
field STRING Required. The column to bucket by.
size INTEGER Optional. Maximum number of buckets to return. Capped server-side.
shard_size INTEGER Optional. Number of candidate buckets collected per shard before the final reduce. Capped server-side.
min_doc_count INTEGER Optional. Minimum document count for a bucket to be returned. Default 1.
shard_min_doc_count INTEGER Optional. Per-shard minimum document count before a bucket is considered.
show_term_doc_count_error BOOLEAN Optional. Whether to return the per-bucket document-count error bound.
order OBJECT Optional. Bucket sort order — a {metric: "asc|desc"} object or an array of them.
include OBJECT Optional. Terms to include — a regex string or an array of exact values.
exclude OBJECT Optional. Terms to exclude — a regex string or an array of exact values.
missing OBJECT Optional. Bucket value assigned to documents missing field.
collect_mode STRING Optional. breadth_first or depth_first sub-aggregation collection strategy.
execution_hint STRING Optional. Internal execution strategy hint (map / global_ordinals).
format STRING Optional. Format applied to the bucket key in the response.
value_type STRING Optional. Explicit value type for the field when it cannot be inferred.