Get campaign report
Report of one sent campaign: sent, opened, clicked, unsubscribed, bounced and complained, plus links clicked.
GET https://cotlet.dev/api/v1/emailoctopus/campaigns/{campaign_id}/report
read
Returns the counts and rates of the report on the Reports tab: sent, opened, clicked, unsubscribed, hard and soft bounces, complained, and each tracked link with its unique and total clicks. A report appears within minutes of sending, at busy times after up to a couple of hours, so a campaign that is still sending returns a notice instead of numbers. Links with a merge tag or custom field in the address are not tracked. On the free Starter plan reports stay available for 30 days.
Parameters
| Name | Type | Description |
|---|---|---|
| campaign_id string required | string | Campaign ID from list_campaigns. |
Request
curl https://cotlet.dev/api/v1/emailoctopus/campaigns/campaign_8c41d2/report \
-H "Authorization: Bearer $COTLET_API_KEY"result = client.call("emailoctopus", "get_campaign_report", {"campaign_id":"campaign_8c41d2"})const result = await cotlet.call('emailoctopus', 'get_campaign_report', {"campaign_id":"campaign_8c41d2"});cotlet call emailoctopus get_campaign_report --data '{"campaign_id":"campaign_8c41d2"}'Example response
{
"campaign_id": "c7a41b92-0d3e-4f58-b6a1-2e9d8c5f7014",
"name": "Autumn offer",
"sent": 1840,
"opened": 702,
"open_rate": 38.2,
"clicked": 96,
"click_rate": 5.2,
"unsubscribed": 9,
"bounced": {
"hard": 14,
"soft": 22
},
"complained": 1,
"links": [
{
"url": "https://northside.example/menu",
"unique_clicks": 71,
"total_clicks": 88
},
{
"url": "https://northside.example/pricing",
"unique_clicks": 25,
"total_clicks": 31
}
]
}