API
Click here for a complete list of operations.
ListCampaignActivities
Retrieves a list of contacts who were sent a campaign. You may not request more than 1000 records at a time using the "select" parameter. Use the select and skip feature to retrieve all information.
Test
The test form is only available for requests from the local machine.SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
POST /api.asmx HTTP/1.1 Host: r2-api.dotdigital.com Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "http://apiconnector.com/ListCampaignActivities" <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ListCampaignActivities xmlns="http://apiconnector.com"> <username>string</username> <password>string</password> <campaignId>int</campaignId> <select>int</select> <skip>int</skip> </ListCampaignActivities> </soap:Body> </soap:Envelope>
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ListCampaignActivitiesResponse xmlns="http://apiconnector.com"> <ListCampaignActivitiesResult> <APICampaignContactSummary> <Email>string</Email> <NumOpens>int</NumOpens> <NumClicks>int</NumClicks> <Unsubscribed>boolean</Unsubscribed> <NumViews>int</NumViews> <NumEstimatedForwards>int</NumEstimatedForwards> <NumForwardToFriend>int</NumForwardToFriend> <NumReplies>int</NumReplies> <ContactId>int</ContactId> <DateFirstOpened>dateTime</DateFirstOpened> <DateLastOpened>dateTime</DateLastOpened> <DateSent>dateTime</DateSent> <FirstOpenIp>string</FirstOpenIp> <FirstOpenUserAgent>string</FirstOpenUserAgent> <SoftBounced>boolean</SoftBounced> <HardBounced>boolean</HardBounced> </APICampaignContactSummary> <APICampaignContactSummary> <Email>string</Email> <NumOpens>int</NumOpens> <NumClicks>int</NumClicks> <Unsubscribed>boolean</Unsubscribed> <NumViews>int</NumViews> <NumEstimatedForwards>int</NumEstimatedForwards> <NumForwardToFriend>int</NumForwardToFriend> <NumReplies>int</NumReplies> <ContactId>int</ContactId> <DateFirstOpened>dateTime</DateFirstOpened> <DateLastOpened>dateTime</DateLastOpened> <DateSent>dateTime</DateSent> <FirstOpenIp>string</FirstOpenIp> <FirstOpenUserAgent>string</FirstOpenUserAgent> <SoftBounced>boolean</SoftBounced> <HardBounced>boolean</HardBounced> </APICampaignContactSummary> </ListCampaignActivitiesResult> </ListCampaignActivitiesResponse> </soap:Body> </soap:Envelope>
SOAP 1.2
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
POST /api.asmx HTTP/1.1 Host: r2-api.dotdigital.com Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <ListCampaignActivities xmlns="http://apiconnector.com"> <username>string</username> <password>string</password> <campaignId>int</campaignId> <select>int</select> <skip>int</skip> </ListCampaignActivities> </soap12:Body> </soap12:Envelope>
HTTP/1.1 200 OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <ListCampaignActivitiesResponse xmlns="http://apiconnector.com"> <ListCampaignActivitiesResult> <APICampaignContactSummary> <Email>string</Email> <NumOpens>int</NumOpens> <NumClicks>int</NumClicks> <Unsubscribed>boolean</Unsubscribed> <NumViews>int</NumViews> <NumEstimatedForwards>int</NumEstimatedForwards> <NumForwardToFriend>int</NumForwardToFriend> <NumReplies>int</NumReplies> <ContactId>int</ContactId> <DateFirstOpened>dateTime</DateFirstOpened> <DateLastOpened>dateTime</DateLastOpened> <DateSent>dateTime</DateSent> <FirstOpenIp>string</FirstOpenIp> <FirstOpenUserAgent>string</FirstOpenUserAgent> <SoftBounced>boolean</SoftBounced> <HardBounced>boolean</HardBounced> </APICampaignContactSummary> <APICampaignContactSummary> <Email>string</Email> <NumOpens>int</NumOpens> <NumClicks>int</NumClicks> <Unsubscribed>boolean</Unsubscribed> <NumViews>int</NumViews> <NumEstimatedForwards>int</NumEstimatedForwards> <NumForwardToFriend>int</NumForwardToFriend> <NumReplies>int</NumReplies> <ContactId>int</ContactId> <DateFirstOpened>dateTime</DateFirstOpened> <DateLastOpened>dateTime</DateLastOpened> <DateSent>dateTime</DateSent> <FirstOpenIp>string</FirstOpenIp> <FirstOpenUserAgent>string</FirstOpenUserAgent> <SoftBounced>boolean</SoftBounced> <HardBounced>boolean</HardBounced> </APICampaignContactSummary> </ListCampaignActivitiesResult> </ListCampaignActivitiesResponse> </soap12:Body> </soap12:Envelope>