Skip to content
  • Documentation >
  • Search >
  • Aggregation reference >
  • DateRangeAggregation

DateRangeAggregation

The field-based DateRangeAggregation aggregates search results by the value of the Date, DateTime, or Time field.

Arguments

  • name - name of the Aggregation
  • contentTypeIdentifier - string representing the content type identifier
  • fieldDefinitionIdentifier - string representing the Field Definition identifier
  • ranges - array of Range objects that define the borders of the specific range sets

Example

1
2
3
4
5
6
7
$query = new Query();
$query->aggregations[] = new Aggregation\Field\DateRangeAggregation('date', 'event', 'event_date',
[
    new Query\Aggregation\Range(null, new DateTime('2020-06-01')),
    new Query\Aggregation\Range(new DateTime('2020-06-01'), new DateTime('2020-12-31')),
    new Query\Aggregation\Range(new DateTime('2020-12-31'), null),
]);