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.

Headers

X-Brand-Id
string

The brand this request acts on. REQUIRED for organization-scoped credentials (otherwise 400 BRAND_ID_REQUIRED — there is no default brand); list ids with GET /v1/brands. Brand-scoped credentials may omit it, and sending a different brand returns 403 BRAND_SCOPE_MISMATCH. A brand outside your organization returns 404 BRAND_NOT_FOUND.

Required string length: 1 - 64

Query Parameters

from
string<date-time>
to
string<date-time>
recipientEmail
string<email>
recipient
string

CSV of recipient rules (max 10) matching who RECEIVED the email: a full address matches exactly, @domain matches the domain, any other text matches as a substring; prefix ! to exclude (e.g. @clay.com,!ceo@clay.com). Includes OR together; excludes always apply. Narrows the feed to email events.

Required string length: 1 - 2048
eventType
string
Required string length: 1 - 64
automationId
string
Required string length: 1 - 64
sendId
string
Required string length: 1 - 64
messageClass
enum<string>

Admission snapshot on the send behind the event (marketing | transactional). Same event object for both classes; absent stamps match as marketing. Narrows the feed to email events.

Available options:
marketing,
transactional
transactionId
string

Transactional-object scope (txn_…): events from EVERY fire of one reusable transactional email object. Prefer this over sendId for object-level reporting; rows carry transactionId back. Narrows the feed to email events.

Required string length: 1 - 128
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).

includeMachineOpens
boolean

Machine/bot-classified opened rows (security-scanner pixel detonation, Apple-proxy prefetch) and still-classifying opens are excluded by default. Pass true to include the raw rows (they carry machineGenerated + an openBotReason and openFetchSource; 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