2.2 KiB
2.2 KiB
Interface AggregationsDateHistogramAggregation
| Name | Type | Description |
|---|---|---|
calendar_interval |
AggregationsCalendarInterval | Calendar-aware interval. Can be specified using the unit name, such as month, or as a single unit quantity, such as 1M. |
extended_bounds |
AggregationsExtendedBounds<AggregationsFieldDateMath> | Enables extending the bounds of the histogram beyond the data itself. |
field |
Field | The date field whose values are use to build a histogram. |
fixed_interval |
Duration | Fixed intervals: a fixed number of SI units and never deviate, regardless of where they fall on the calendar. |
format |
string | The date format used to format key_as_string in the response. If no format is specified, the first date format specified in the field mapping is used. |
hard_bounds |
AggregationsExtendedBounds<AggregationsFieldDateMath> | Limits the histogram to specified bounds. |
interval |
Duration | |
keyed |
boolean | Set to true to associate a unique string key with each bucket and return the ranges as a hash rather than an array. |
min_doc_count |
integer | Only returns buckets that have min_doc_count number of documents. By default, all buckets between the first bucket that matches documents and the last one are returned. |
missing |
DateTime | The value to apply to documents that do not have a value. By default, documents without a value are ignored. |
offset |
Duration | Changes the start value of each bucket by the specified positive ( +) or negative offset ( -) duration. |
order |
AggregationsAggregateOrder | The sort order of the returned buckets. |
params |
Record<string, any> | |
script |
Script | ScriptSource |
time_zone |
TimeZone | Time zone used for bucketing and rounding. Defaults to Coordinated Universal Time (UTC). |