Campaigns API
GET /api/v1/campaigns/{id}
Returns one campaign plus its delivery analytics. Requires the read:campaigns scope.
Request
GET /api/v1/campaigns/cmq2camp0alk34567890 HTTP/1.1
Host: agentlyleads.com
Authorization: Bearer alk_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxResponse (200)
{
"campaign": { "id": "cmq2camp0alk34567890", "name": "Spring restock", "status": "SENT", "...": "..." },
"analytics": {
"totalRecipients": 120,
"sentRecipients": 114,
"skippedRecipients": 4,
"failedRecipients": 2,
"delivered": 110,
"opens": 41,
"machineOpens": 17,
"threadReviewOpens": 5,
"clicks": 9,
"machineClicks": 3,
"humanOpens": 52,
"automaticOpens": 19,
"humanClicks": 11,
"scannerClicks": 27,
"bounces": 3,
"unsubscribes": 1,
"complaints": 0,
"replies": 6,
"positiveReplies": 2
}
}Analytics fields
| Field | Meaning |
|---|---|
totalRecipients | Recipients queued at launch |
sentRecipients | Recipients whose email was approved and sent |
skippedRecipients | Skipped because the address is suppressed |
failedRecipients | The send failed |
delivered, bounces, unsubscribes, complaints | Delivery events |
opens | Distinct emails opened by a person. A repeat open within 30 seconds counts once |
machineOpens | Distinct emails with an open by software (Apple Mail Privacy Protection, security scanners). Not counted in opens |
threadReviewOpens | Distinct emails reloaded after the recipient replied. The email is quoted in the thread, so later views of the conversation reload it. Not counted in opens |
clicks | Distinct emails with a click by a person |
machineClicks | Distinct emails with a click by software (link scanners, HTTP libraries, a click seconds after sending). Not counted in clicks |
humanOpens, humanClicks | Open and click events by a person, summed over every email in the campaign |
automaticOpens, scannerClicks | Automatic opens and security-scanner clicks (Safe Links, Mimecast, Proofpoint). Recorded, never counted. See Opens and clicks |
replies | Conversations that got a reply |
positiveReplies | Replies classified as interested |
An ID from another workspace returns 404 { "error": "Campaign not found." }.