Skip to main content
GET
Unified events feed

Authorizations

Authorization
string
header
default:Bearer brew_your_api_key
required

Send your Brew API key as Authorization: Bearer brew_xxx.

Query Parameters

from
string<date-time>
to
string<date-time>
recipientEmail
string<email>
eventType
string
Required string length: 1 - 64
automationId
string
Required string length: 1 - 64
sendId
string
Required string length: 1 - 64
source
string

Send-object facet: CSV of send sources (valid values: audience, api, automation_manual, automation_integration, automation_custom). Narrows the feed to email events.

Required string length: 1 - 256
audienceId
string

Send-object facet: CSV of audience ids (max 20) — events from the audiences' sends. Narrows the feed to email events.

Required string length: 1 - 2048
emailId
string

Send-object facet: one email design id. Narrows the feed to email events.

Required string length: 1 - 64
domain
string

Send-object facet: a sending domain (fromEmail match). Narrows the feed to email events.

Required string length: 1 - 255
triggerEventId
string

Send-object facet: CSV of integration trigger-event ids (max 10), resolved to their wired automations. Narrows the feed to email events.

Required string length: 1 - 2048
includeMachineClicks
boolean

Machine/bot-classified clicked rows are excluded by default. Pass true to include the raw rows (they carry machineGenerated: true + a clickBotReason; audit/debug only).

limit
integer
Required range: 1 <= x <= 100
cursor
string
Required string length: 1 - 8192

Response

A page of unified analytics events.

data
object[]
required
pagination
object
required
range
object
required