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.

DescriptionTOP

Privileges required: contacts:read

Retrieves a list of all link clicks for the campaign specified by the campaignId path parameter (REQUIRED). Use the created_since query parameter to retrieve only the clicks that occurred on or after the date/time specified. This is useful for syncing tracking data across applications.

NOTE: Tracking information is only available for SENT email campaigns.

DescriptionTOP

Privileges required: contacts:read

Retrieves a report showing all email campaigns that bounced when sent to the contact specified by the contactId path parameter.

Bounce reasons

See this FAQ that details the types of bounces we track. 

DescriptionTOP

Privileges required: contacts:read

Retrieve a list of contacts that unsubscribed from an email campaign specified by the campaignId path parameter. Use the created_since query parameter to retrieve only the contacts that unsubscribed on or after the date/time specified. This is useful for sync'ing tracking data across applications.

NOTE: Tracking information is only available for SENT email campaigns. 

DescriptionTOP

Privileges required: contacts:read

Retrieve a list of contacts that the email campaign specified by the campaignId path parameter (REQUIRED). Use the created_since query parameter to retrieve only the email addresses that were sent the campaign on or after the date/time specified. This is useful for sync'ing tracking data across applications.

NOTE: Tracking information is only available for SENT email campaigns.

DescriptionTOP

Privileges required: contacts:read

Retrieves a list of email addresses that opened the email campaign specified by campaignId path parameter (REQUIRED). Use the created_since query parameter to retrieve only those opens that occurred on or after the date/time specified. This is useful for sync'ing tracking data across applications.

NOTE: Tracking information is only available for SENT email campaigns.

DescriptionTOP

Privileges required: contacts:read

Retrieves a list of contacts that forwarded the email campaign specified by the campaignId path parameter. Use the created_since query parameter to retrieve only the forward activities that occurred on or after the date/time specified. This is useful for sync'ing tracking data across applications.

NOTE: Tracking information is only available for SENT email campaigns.

DescriptionTOP

Privileges required: contacts:read

Retrieves a list of all click activities for the email campaign specified by the campaignId path parameter (REQUIRED). Use the created_since query parameter to retrieve only the click activities that occurred on or after the date/time specified. This is useful for sync'ing tracking data across applications.

NOTE: Tracking information is only available for SENT email campaigns.

DescriptionTOP

Privileges required: contacts:read

Retrieves a list of all contacts that clicked the email campaign link specified by the linkId and campaignId path parameters (REQUIRED). Use the created_since query parameter to retrieve only the contacts who clicked links on or after the date/time specified. This is useful for sync'ing tracking data across applications.

NOTE: Tracking information is only available for SENT email campaigns

Response CodesTOP

StructureTOP

Example ResponseTOP

{
    "meta": {
        "pagination": {
            "next_link": "/v2/emailmarketing/campaigns/1100388730957/tracking/bounces?next=c3RhcnRBdD0zJmxpbWl0PTI"
        }
    },
    "results": [
        {
            "activity_type": "EMAIL_BOUNCE",
            "campaign_id": "1100388730957",
            "contact_id": "1159",
            "email_address": "user1@example.com",
            "bounce_code": "B",
            "bounce_description": "Non-existent address",
            "bounce_message": "",
            "bounce_date": "2009-11-25T09:29:28.406Z"
        },
        {
            "activity_type": "EMAIL_BOUNCE",
            "campaign_id": "1100388730957",
            "contact_id": "1161",
            "email_address": "user2@example.com",
            "bounce_code": "B",
            "bounce_description": "Non-existent address",
            "bounce_message": "",
            "bounce_date": "2009-12-02T09:34:26.382Z"
        }
       
     ] 
}