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

Download Open API Spec

DateRangeAggregation

org.sagebionetworks.repo.model.search.dsl.DateRangeAggregation

A date_range bucket aggregation — one bucket per caller-defined date range.

Field Type Description
keyed BOOLEAN Optional. Whether to return buckets as a keyed object rather than an array.
field STRING Required. The date column to bucket.
ranges ARRAY<AggregationRange> Required. The bucket ranges. Bound values may be dates or date-math expressions.
time_zone STRING Optional. UTC offset or IANA zone used to interpret the range bounds.
missing OBJECT Optional. Value assigned to documents missing field.
format STRING Optional. Date format applied to the bucket key in the response.