13 lines
3.8 KiB
Markdown
13 lines
3.8 KiB
Markdown
# EventsAggregateParams
|
|
|
|
|
|
## Fields
|
|
|
|
| Field | Type | Required | Description |
|
|
| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
|
|
| `customer_id` | *str* | :heavy_check_mark: | Customer ID to aggregate events for |
|
|
| `feature_id` | [models.AggregateEventsFeatureID](../models/aggregateeventsfeatureid.md) | :heavy_check_mark: | Feature ID(s) to aggregate events for |
|
|
| `group_by` | *Optional[str]* | :heavy_minus_sign: | 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]](../models/range.md) | :heavy_minus_sign: | Time range to aggregate events for. Either range or custom_range must be provided |
|
|
| `bin_size` | [Optional[models.BinSize]](../models/binsize.md) | :heavy_minus_sign: | Size of the time bins to aggregate events for. Defaults to hour if range is 24h, otherwise day |
|
|
| `custom_range` | [Optional[models.AggregateEventsCustomRange]](../models/aggregateeventscustomrange.md) | :heavy_minus_sign: | Custom time range to aggregate events for. If provided, range must not be provided | |