Campaigns
Get a campaign run report
Returns delivery outcomes, topic unsubscribes, replies, and skip reasons for an email campaign run.
Returns delivery outcomes, topic unsubscribes, replies, and skip reasons for an email campaign run. Non-email runs return 404. Namespace-scoped reads require an existing audience topic in that namespace. Opens and clicks are directional counts of unique recipients excluding machine events, not exact measurements.
Authorization
apiKey x-api-key<token>
In: header
Path Parameters
id*string
Match
^camp_[0-9a-hjkmnp-tv-z]{16,24}$runId*string
Match
^crun_[0-9a-hjkmnp-tv-z]{16,24}$Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/campaigns/string/runs/string/report"{ "campaignId": "string", "runId": "string", "totalRecipients": 0, "dispatchedCount": 0, "failedCount": 0, "skippedCount": 0, "deliveredCount": 0, "hardBounceCount": 0, "softBounceCount": 0, "complaintCount": 0, "engagement": { "measurement": "directional", "uniqueOpens": 0, "uniqueClicks": 0 }, "unsubscribesByTopic": [ { "topicId": "string", "count": 0 } ], "replyCount": 0, "skippedReasons": [ { "reason": "unsubscribed", "count": 0 } ]}