API Web Service

API

Click here for a complete list of operations.

ListCampaignActivitiesSinceDate

Retrieves a list of contacts who were sent a campaign, and retrieves only those contacts who responded (e.g. clicked, opened) after a specified date. 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: api.dotmailer.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://apiconnector.com/ListCampaignActivitiesSinceDate"

<?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>
    <ListCampaignActivitiesSinceDate xmlns="http://apiconnector.com">
      <username>string</username>
      <password>string</password>
      <campaignId>int</campaignId>
      <startDate>dateTime</startDate>
      <select>int</select>
      <skip>int</skip>
    </ListCampaignActivitiesSinceDate>
  </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>
    <ListCampaignActivitiesSinceDateResponse xmlns="http://apiconnector.com">
      <ListCampaignActivitiesSinceDateResult>
        <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>
      </ListCampaignActivitiesSinceDateResult>
    </ListCampaignActivitiesSinceDateResponse>
  </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: api.dotmailer.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>
    <ListCampaignActivitiesSinceDate xmlns="http://apiconnector.com">
      <username>string</username>
      <password>string</password>
      <campaignId>int</campaignId>
      <startDate>dateTime</startDate>
      <select>int</select>
      <skip>int</skip>
    </ListCampaignActivitiesSinceDate>
  </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>
    <ListCampaignActivitiesSinceDateResponse xmlns="http://apiconnector.com">
      <ListCampaignActivitiesSinceDateResult>
        <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>
      </ListCampaignActivitiesSinceDateResult>
    </ListCampaignActivitiesSinceDateResponse>
  </soap12:Body>
</soap12:Envelope>