Unified events feed
Read-only window over the brand’s analytics events across domains (email, automation, trigger, inbound). Defaults to the last 7 days. Equality filters: recipientEmail, eventType, automationId, sendId (join back to /v1/analytics/sends?sendId=), messageClass (marketing | transactional — same event object; absent stamps match as marketing). Recipient rules — recipient (csv, ≤10): a full address matches exactly, @domain matches everyone on that domain, any other text matches as a substring, and a ! prefix excludes (recipient=@clay.com,!ceo@clay.com = clay recipients except the CEO); includes OR together, excludes always apply. Send-object facets — source (csv of send sources), audienceId (csv, ≤20), emailId (design), domain (sending domain), triggerEventId (csv, ≤10 — integration trigger-events resolved to their wired automations), messageClass: when ANY facet or recipient rule is present the feed narrows to EMAIL events only and each row is enriched with sendSource + sendContext + messageClass (plus triggerProvider/triggerTitle on integration/custom-triggered rows). Overview/insights collect transactional events like any other email event. Machine/bot-classified clicked AND opened rows (scanner detonation, Apple-proxy prefetch) are EXCLUDED by default (matching /v1/analytics/overview); pass includeMachineClicks=true / includeMachineOpens=true to include the raw rows (audit/debug only). Cursor pagination — pass pagination.cursor back as ?cursor=; loop while (cursor !== null). Requires the emails scope.
Authorizations
Send your Brew API key as Authorization: Bearer brew_xxx.
Headers
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.
1 - 64Query Parameters
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.
1 - 20481 - 641 - 641 - 64Admission 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.
marketing, transactional 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.
1 - 128Send-object facet: CSV of send sources (valid values: audience, api, automation_manual, automation_integration, automation_custom). Narrows the feed to email events.
1 - 256Send-object facet: CSV of audience ids (max 20) — events from the audiences' sends. Narrows the feed to email events.
1 - 2048Send-object facet: one email design id. Narrows the feed to email events.
1 - 64Send-object facet: a sending domain (fromEmail match). Narrows the feed to email events.
1 - 255Send-object facet: CSV of integration trigger-event ids (max 10), resolved to their wired automations. Narrows the feed to email events.
1 - 2048Machine/bot-classified clicked rows are excluded by default. Pass true to include the raw rows (they carry machineGenerated: true + a clickBotReason; audit/debug only).
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).
1 <= x <= 1001 - 8192