3.8 KiB
3.8 KiB
EventsAggregateParams
Fields
| Field | Type | Required | Description |
|---|---|---|---|
customer_id |
str | ✔️ | Customer ID to aggregate events for |
feature_id |
models.AggregateEventsFeatureID | ✔️ | Feature ID(s) to aggregate events for |
group_by |
Optional[str] | ➖ | Property to group events by. If provided, each key in the response will be an object with distinct groups as the keys |
range |
Optional[models.Range] | ➖ | Time range to aggregate events for. Either range or custom_range must be provided |
bin_size |
Optional[models.BinSize] | ➖ | Size of the time bins to aggregate events for. Defaults to hour if range is 24h, otherwise day |
custom_range |
Optional[models.AggregateEventsCustomRange] | ➖ | Custom time range to aggregate events for. If provided, range must not be provided |