Campaign analytics
get_campaign_analyticsCampaign performance for a period: sent, delivered, opens, clicks, replies, bounces, unsubscribes and rates. A campaign with subsequences is counted together with them by default (each email and person once); scope: "main" limits it to the main sequence, subsequenceId to one subsequence. breakdown adds per-mailbox (smtp), per-step/variant (sequence) or per-bounce-type (bounce) tables. Pass interval to also get a time series by day/week/month.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Campaign id (UUID). | |
| scope | No | `family` (default): the campaign with its subsequences. `main`: the main sequence only. | |
| endDate | No | Last day, ISO date (YYYY-MM-DD). Defaults to today. Only used together with startDate. | |
| interval | No | Also return a time series at this granularity (long windows may be returned coarser). | |
| breakdown | No | ||
| startDate | No | First day, ISO date (YYYY-MM-DD), whole days in the workspace timezone. Without startDate the window is the LAST 7 DAYS (endDate alone is ignored). Clipped to the plan retention. | |
| excludeOOO | No | Exclude out-of-office auto-replies from reply counts. | |
| subsequenceId | No | Only this subsequence of the campaign (id from list_subsequences); overrides `scope` (UUID). |