HistogramAggregation
org.sagebionetworks.repo.model.search.dsl.HistogramAggregation
A histogram bucket aggregation over a numeric column. Must specify extended_bounds or hard_bounds so the bucket count is bounded.
| Field | Type | Description |
|---|---|---|
| keyed | BOOLEAN | Optional. Whether to return buckets as a keyed object rather than an array. |
| extended_bounds | ExtendedBounds | Min/max bounds that force a histogram or date_histogram to emit buckets across the full range (used as extended_bounds or hard_bounds). Bounding the range is what caps the bucket count. |
| hard_bounds | ExtendedBounds | Min/max bounds that force a histogram or date_histogram to emit buckets across the full range (used as extended_bounds or hard_bounds). Bounding the range is what caps the bucket count. |
| field | STRING | Required. The numeric column to bucket. |
| interval | NUMBER | Required. Bucket width. Must be positive. |
| min_doc_count | INTEGER | Optional. Minimum document count for a bucket to be returned. |
| offset | NUMBER | Optional. Shifts bucket boundaries by this amount. |
| order | OBJECT | Optional. Bucket sort order — a {metric: "asc|desc"} object or an array of them. |
| missing | OBJECT | Optional. Bucket value assigned to documents missing field. |
| format | STRING | Optional. Format applied to the bucket key in the response. |