An event group is a container that organizes conversion events for attribution and optimization. Event groups belong to an ad account and can be used in two ways: to associate a set of tracked conversion events with an ad group for measurement and optimization, and to create event-based custom audiences.
To use an event group for campaign optimization, attach it to an ad group using the event_group_uid attribute. Roku then uses those events to measure and optimize campaign performance. To build an event-based custom audience, pass an event_group_uid in a POST Create custom audiences call.
Event groups work in conjunction with the Roku Pixel and Conversions API. Conversion events tracked through either of those integrations are organized into event groups, which you can then reference at the ad group level for campaign optimization, or when creating a custom audience for targeting.
Event group attributes
Each event group contains the following attributes:
| Attribute | Description |
|---|---|
name | The name of the event group. |
account_uid | The unique identifier of the ad account the event group belongs to. |
automatic_advanced_matching | When true, enables automatic advanced matching to improve attribution by using additional signals to match conversions to ad exposures. |
first_party_cookie | When true, enables first-party cookie tracking to improve measurement accuracy. |
is_active | Indicates whether the event group is currently active. |
is_deleted | Indicates whether the event group has been deleted. |
is_default | Indicates whether this is the default event group for the account. |
created_at | The date and time the event group was created, in ISO 8601 format. |
last_updated_at | The date and time the event group was last updated, in ISO 8601 format. |
deleted_at | The date and time the event group was deleted, in ISO 8601 format. null if not deleted. |
List event groups
To retrieve all event groups you have access to, make a GET List event groups call. The response returns a list of event groups along with a count and total_count, which indicate the number of event groups received and the total number available, respectively.
The following query parameters are available:
| Parameter | Type | Description |
|---|---|---|
uid | array of strings | A set of unique identifiers to retrieve. Use this to fetch one or more specific event groups by uid. |
account_uid | array of strings | A comma-separated list of account uid values to filter event groups by. Useful when you have access to multiple accounts. |
limit | number | The maximum number of results to return. Default: 20. |
offset | number | The starting position of results. Use in conjunction with limit to paginate through results. For example, a limit of 2 and an offset of 10 returns items 11–12. Default: 0. |
order | string | The field to sort results by. Use + or - to specify ascending or descending order. Defaults to ascending if no symbol is provided. For example: +created_at. |