v1

latestOpenAPI 3.1.02026-07-2670105729.6 KB
Analytics

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=). 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): when ANY facet is present the feed narrows to EMAIL events only and each row is enriched with sendSource + sendContext (plus triggerProvider/triggerTitle on integration/custom-triggered rows). Machine/bot-classified clicked rows are EXCLUDED by default (matching /v1/analytics/overview); pass includeMachineClicks=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.

get/v1/analytics/events

Query parameters

fromstring date-time
tostring date-time
recipientEmailstring email
eventTypestring
automationIdstring
sendIdstring
sourcestring

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

audienceIdstring

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

emailIdstring

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

domainstring

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

triggerEventIdstring

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

includeMachineClicksboolean

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).

limitinteger
cursorstring

Response

A page of unified analytics events.