Sign in

v101

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-08235133843.7 KB
Analytics

List sequence events

Returns paginated raw email events for every email step in a sequence, or for one step via automationNodeId. Defaults to delivery events. This is the per-recipient stream; for per-step totals read the steps array of the sequence metrics endpoint or GET /metrics/emails.

get/metrics/sequences/{sequenceId}/events

Path parameters

sequenceIdstring required

Sequence (automation) ID

Query parameters

automationNodeIdstring

Scope the stream to one email step of this sequence. Take the node ID from the steps array of the sequence metrics endpoint. A node that is not an email step of this sequence returns 400.

eventType'send' | 'delivery' | 'bounce' | 'complaint' | 'open' | 'click' | 'unsubscribe' | 'delivery_delay' | 'transport_failure'

Single event type to include. Defaults to delivery when no event type filter is provided.

eventTypesstring
Example:delivery,open,click

Comma-separated event types to include. Supported values are send, delivery, bounce, complaint, open, click, unsubscribe, delivery_delay, and transport_failure.

period'1h' | '24h' | '7d' | '30d' | '90d'

Sliding time window. Ignored when start and end are provided.

startstring date-time

Start of custom time range (ISO 8601). Must be used with end.

endstring date-time

End of custom time range (ISO 8601). Must be used with start. Max range: 90 days.

pageinteger

Page number

limitinteger

Events per page (max 500)

includeMachineEngagementboolean

Include detected scanner, preview, and tracked asset open/click events when requesting engagement event types.

Response

Success

successboolean
sequenceIdstring
automationNodeIdsstring[]
eventTypesstring[]

Example response

{
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 100,
    "totalPages": 5
  }
}