Event audience breakdown
GET /api/sites/{id}/events/audience
Returns the top pages, referrers, devices, and countries for sessions that contain the given event. All four dimensions are returned in one response (top 10 per dimension), scoped to sessions where the event fired. Optionally filter by a property value or audience dimension.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”Query Parameters
Section titled “Query Parameters ”The event name to scope audience to.
Optional property key. When combined with property_value, restricts to sessions where the event has this property.
Optional property value filter. Requires property_key.
Optional dimension to filter sessions by. When set, only sessions where the matching hit dimension equals dimension_value are included.
Optional dimension value filter. Requires dimension_key.
Responses
Section titled “ Responses ”Event audience breakdown
Top audience dimensions for sessions that contain a specific event.
object
Top pages visited during event sessions (up to 10).
object
Top referrers for event sessions (up to 10).
object
Top device types (Desktop / Mobile) for event sessions (up to 10).
object
Top countries for event sessions (up to 10). Values are ISO 3166-1 alpha-2 country codes.