For AI agents: the complete documentation index is available at llms.txt; this page is also available as Markdown at index.md.

• Documentation >
• Search >
• Aggregation reference >
• DateTimeRangeAggregation

DateTimeRangeAggregation

The field-based DateTimeRangeAggregation 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

You can use this Aggregation over the REST API, in the Aggregations element of the payload of the POST /views request:

"Query": {
    "Aggregations": [
        {
            "DateTimeRangeAggregation": {
                "name": "aggregation_name",
                "contentTypeIdentifier": "event",
                "fieldDefinitionIdentifier": "start_date",
                "ranges": [
                    {
                        "from": null,
                        "to": "2024-01-01T00:00:00+00:00"
                    },
                    {
                        "from": "2024-01-01T00:00:00+00:00",
                        "to": null
                    }
                ]
            }
        }
    ]
}

Copy as Markdown View as Markdown View on GitHub