# TimeRangeAggregation

> For the complete documentation index, see [llms.txt](https://doc.ibexa.co/en/saas/llms.txt).

TimeRangeAggregation

The field-based TimeRangeAggregation 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`](https://doc.ibexa.co/en/saas/api/rest_api/rest_api_reference/rest_api_reference.html#tag/Views/operation/ibexa.rest.views.create) request:

```json
"Query": {
    "Aggregations": [
        {
            "TimeRangeAggregation": {
                "name": "aggregation_name",
                "contentTypeIdentifier": "event",
                "fieldDefinitionIdentifier": "start_time",
                "ranges": [
                    {
                        "from": 0,
                        "to": 43200
                    },
                    {
                        "from": 43200,
                        "to": 86400
                    }
                ]
            }
        }
    ]
}
```