Analytics
Get recipient engagement
Returns a paginated list of recipients with their open, click, and unsubscribe events. Use this to sync engagement data to your own database.
get/metrics/recipients
Query parameters
emailstring
Filter to a single recipient by email address
campaignIdstring
Filter to recipients of a specific campaign
sequenceIdstring
Filter to recipients of a specific sequence
period'1h' | '24h' | '7d' | '30d' | '90d'
Sliding time window. Ignored when start/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
Recipients per page (max 100)
includeMachineEngagementboolean
Include detected scanner, preview, and tracked asset open/click events in recipient engagement arrays.
Response
Success
Example response
{
"pagination": {
"page": 1,
"limit": 20,
"total": 100,
"totalPages": 5
}
}