Email Metrics
get-email-metricsRetrieve email delivery and engagement metrics for any date range. Filter by period, domain, email, or broadcast to diagnose performance and optimize campaigns.
Instructions
Retrieve account-level email delivery and engagement metrics (sent, delivered, bounced, opened, clicked, etc.) for a date range, optionally broken down by period, domain, email, or broadcast.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| emailId | No | Restrict the response to these email IDs (max 100). Cannot be combined with the "broadcast" dimension or broadcastId. | |
| endDate | No | End of the date range, as an ISO 8601 date or datetime. Defaults to now. | |
| metrics | No | Metrics to include in the response. Defaults to all metrics. | |
| domainId | No | Restrict the response to these sending domain IDs (max 100). | |
| timezone | No | IANA timezone (e.g. "America/New_York") used to bucket periods when "period" is in dimensions. Defaults to UTC. | |
| startDate | No | Start of the date range, as an ISO 8601 date or datetime. Defaults to 6 days before endDate. | |
| dimensions | No | Dimensions to break the response down by. "email" and "broadcast" cannot be combined. Defaults to none, which returns totals only. | |
| broadcastId | No | Restrict the response to these broadcast IDs (max 100). Cannot be combined with the "email" dimension or emailId. | |
| granularity | No | Bucket size used when "period" is in dimensions. Defaults to "daily". |