Skip to main content
GET
List Campaign Events
Returns a paginated raw event stream for a campaign. The endpoint defaults to delivery events so you can audit delivered recipients, and can be expanded with eventTypes for opens, clicks, bounces, complaints, unsubscribes, sends, and delivery delays.

Path Parameters

campaignId
string
required
The ID of the campaign.

Query Parameters

eventTypes
string
default:"delivery"
Comma-separated event types. Supported values: send, delivery, bounce, complaint, open, click, unsubscribe, delivery_delay.
eventType
string
Single event type convenience alias. If both eventType and eventTypes are provided, both are included.
period
string
Sliding time window. One of: 1h, 24h, 7d, 30d, 90d. Ignored when start and end are provided.
start
string
Start of custom time range (ISO 8601). Must be used with end.
end
string
End of custom time range (ISO 8601). Must be used with start. Max range: 90 days.
page
number
default:"1"
Page number for pagination.
limit
number
default:"100"
Events per page (max 500).
includeMachineEngagement
boolean
default:"false"
Set to true to include detected scanner, preview, and tracked asset open/click events when requesting engagement event types.

Common Queries

List delivered recipients for a campaign

Include clicks with deliveries

Responses