Contact Tracking Forwards Report
Use this endpoint to retrieve a report of all email campaigns that a contact forwarded to others.
Methods:
Click a method to view its documentation
Description TOP
Privileges required : contacts:read
Retrieves a report showing email campaigns that a contact opened. Use the
contactId
path parameter to specify the contact for which to retrieve the report. Use the
created_since
query parameter to retrieve only activity that occurred on or after the date/time specified. This is useful for syncing tracking data across applications.
Description TOP
Privileges required : contacts:read
Retrieves the email campaign forwarding activites for the contact specified by the
contactId
path parameter (REQUIRED). Use the
created_since
query parameter to retrieve only activity that occurred on or after the date/time specified. This is useful for syncing tracking data across applications.
|
GET: https://api.constantcontact.com/v2/contacts/{contactId}/tracking/forwards |
|||
|
name |
type |
default |
description |
|---|---|---|---|
|
api_key |
query |
|
REQUIRED; The API key for the application |
|
contactId |
path |
|
Specifies the contact to retrieve email forwarding activities for |
|
created_since |
query |
|
Use to retrieve only forwards that occurred on or after the date/time specified in ISO-8601 format. |
|
limit |
query |
500 |
Specifies the number of results displayed per page of output, from 1 - 500, default = 500. See
Paginated Output
for more information on using
|
Response Codes TOP
|
code |
description |
|---|---|
|
200 |
Request was successful |
|
401 |
Authentication failure |
|
404 |
contact id not found |
|
406 |
Unsupported accept header value, must be application/json |
|
500 |
Internal server error occurred |
Structure TOP
|
property |
type (max length) |
description |
|---|
Example Response TOP
{
"meta": {
"pagination": {
"next_link": "/v2/emailmarketing/campaigns/51/tracking/forwards?next=c3RhcnRBdD0zJmxpbWl0PTI"
}
},
"results": [
{
"activity_type": "EMAIL_FORWARD",
"campaign_id": "1100394165287",
"contact_id": "51",
"email_address": "email1@example.com",
"forward_date": "2012-12-06T08:06:35.661Z"
},
{
"activity_type": "EMAIL_FORWARD",
"campaign_id": "1100394165288",
"contact_id": "51",
"email_address": "email@example.com",
"forward_date": "2012-12-06T08:06:35.561Z"
}
]
}