Email Campaign Activity Summary Report
Use this endpoint to retrieve a summary report of all activities for an email campaign that was SENT.
Methods:
Click a method to view its documentation
DescriptionTOP
Privileges required: campaign:read
Returns a summary of all activities (Sends, Opens, Clicks, Forwards, Unsubscribes, Bounces) for the email campaign specified by the campaignId path parameter. All data returned is current as of the last scheduled update, unless you set updateSummary=true, which will return updated data.
NOTE: Tracking information is only available for SENT email campaigns.
|
GET: https://api.constantcontact.com/v2/emailmarketing/campaigns/{campaignId}/tracking/reports/summary |
|||
name |
type |
default |
description |
|---|---|---|---|
api_key |
query |
REQUIRED; The API key for the application |
|
campaignId |
path |
Specifies the email campaign to retrieve the summary report for |
|
updateSummary |
query |
false |
Set this to true to retrieve current tracking_summary data, otherwise data is as of last scheduled update |
Response CodesTOP
code |
description |
|---|---|
200 |
Request was successful |
401 |
Authentication failure |
404 |
Campaign ID not found. |
406 |
Unsupported Accept Header value, must be application/json |
500 |
Internal server error occurred |
StructureTOP
|
property |
type(max length) |
description |
|---|---|---|
|
bounces |
integer |
Number of email address bounces for this campaign |
|
clicks |
integer |
Number of unique recipients who clicked a link in this email campaign |
|
forwards |
integer |
Number of unique recipients who forwarded this email campaign |
|
opens |
integer |
Number of unique recipients who opened this email campaign |
|
sends |
integer |
Number of recipients this email campaign was sent to |
|
unsubscribes |
integer |
Number of recipients who unsubscribed from this campaign |
Example ResponseTOP
{
"sends": 15,
"opens": 10,
"clicks": 10,
"forwards": 3,
"unsubscribes": 2,
"bounces": 18
}