Analytics
Get aggregated email metrics
Returns aggregated email engagement metrics for the specified time period. Set emailType=transactional for Send API and transactional SMTP traffic.
get/metrics
Query parameters
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.
emailType'campaign' | 'transactional' | 'sequence'
Structural email type filter. Use transactional for Send API and transactional SMTP traffic.
includeMachineEngagementboolean
Include detected scanner, preview, and tracked asset open/click events.
Response
Success
Example response
{
"commerceForecast": {
"modelVersion": "cohort-rfm-v1"
}
}