Get Campaign Report
mailchimp.get_campaign_report
ActionEmailconnection required
Calls the Mailchimp API with the connection's credentials.
Fetch a sent campaign's report: how many were delivered, opened, clicked, bounced and unsubscribed. A draft or scheduled campaign has no report and the call 404s.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Mailchimp
- Secret shape
- the Mailchimp API key (…-<dc>)
- Config it needs
- dc
- Resolved by
- config.connection_id, else node.connection_id
Configuration
1 field, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
campaign_id The campaign id returned by Mailchimp: Create Campaign or List Campaigns. | string | Yes | — | — | — |
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
id The campaign id the report is for. | string | — |
campaign_title The campaign's title. | string | — |
subject_line The subject line that was sent. | string | — |
list_id The audience the campaign went to. | string | — |
list_name The audience's name. | string | — |
emails_sent How many emails were sent. | number | — |
send_time When the campaign was sent, ISO 8601. | string | — |
bounces Hard, soft and syntax-error bounce counts. | object | — |
opens Total and unique opens, and the open rate. | object | — |
clicks Total and unique clicks, and the click rate. | object | — |
unsubscribed How many members unsubscribed. | number | — |
abuse_reports How many members reported the campaign. | number | — |
forwards Forward counts for the campaign. | object | — |
industry_stats Averages for the account's industry. | object | — |
ecommerce Revenue attributed to the campaign. | object | — |
{
"abuse_reports": 0,
"bounces": {},
"campaign_title": "",
"clicks": {},
"ecommerce": {},
"emails_sent": 0,
"forwards": {},
"id": "",
"industry_stats": {},
"list_id": "",
"list_name": "",
"opens": {},
"send_time": "",
"subject_line": "",
"unsubscribed": 0
}See Get Campaign Report run in a workflow.
In a technical demo we add the Mailchimp connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.