List campaign activities

The ListCampaignActivities method returns a list of contacts that were sent a specified campaign after a certain dateTime.

Guidance Notes

It will only return up to 1000 records at a time. To iterate through the whole data set you should use the select and skip parameters. For example to select the first 1000 records in the data set you should set the select parameter to 1000 and the skip parameter to 0. To select the next 1000 records you should set the select parameter to 1000 and the skip parameter to 1000. You should continue to do this until 0 records are returned to you to get the whole data set.

If you are unsure about the server time please use GetServerTime.

Parameters

username	string	This is the username from your API key. It is in the format of an email address and will look similar to apiuser*#8209;908709770324@apiconnector.com	required
password	string	This is the password from your API key.	required
campaignId	int	This is the ID of the campaign you wish to query against.	required
startDate	dateTime	This is the dateTime you wish to begin selecting data from	required
select	int	This is a number which indicates the number of records you wish to select. This argument must no greater than 1000	required
skip	int	This is a number which is the number of records you want to skip; to select all records from 1001 to 2000: set this number to 1000.	required

Return values

The result is an array of APIContactSummary objects, each consisting of the following:

email	string	The email address of the contact.
numOpens	int	The number of times the contact has been tracked as having opened the campaign.
numClicks	int	The number times the user has been tracked as having clicked on a link in the campaign.
unsubscribed	boolean	Whether or not the campaign triggered the user to unsubscribe.
numViews	int	The number of website pageviews tracked following a click in the campaign if you are using dotMailer pagetracking on your site.
numEstimatedForwards	int	The estimated number of times the contact forwarded the campaign (and it was subsequently opened).
numForwardToFriend	int	The number of addresses the contact used the "Forward to a Friend" link and functionality for.
numReplies	int	The number of replies received to the campaign sent to that contact.
contactId	int	The ID number for the contact.
dateFirstOpened	dateTime	The date and time of the first tracked open of the campaign for the contact.
dateLastOpened	dateTime	The date and time of the most recent tracked open of the campaign for the contact.
dateSent	dateTime	The date and time the campaign was sent to the contact. If it has been sent to the contact more than once, this is the most recent date and time it was sent.
firstOpenIp	string	The IP address the contact was first tracked as having opened the campaign at.
firstOpenUserAgent	string	This element is a legacy feature and will be returned empty.
softBounced	boolean	Whether or not a soft bounce was received for the contact for this campaign.
hardBounced	boolean	Whether or not a hard bounce was received for the contact for this campaign.

Error responses

ERROR_CAMPAIGN_INVALID
ERROR_CAMPAIGN_NOT_FOUND
ERROR_APIUSAGE_EXCEEDED
ERROR_INVALID_LOGIN
ERROR_PARAMETER_INVALID
ERROR_SYSTEM_SERVICETEMPORARILYUNAVAILABLE
ERROR_UNKNOWN

Request

POST /API.asmx HTTP/1.1
Host: apiconnector.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://apiconnector.com/ListCampaignActivitiesSinceDate"

Example of use in C# .NET

/// <summary>
/// This method allows you to get a list of contacts that were sent a specified campaign after a certain dateTime. 
/// It will only return up to 1000 records at a time, and will need to be paged to access all of
/// the results
/// </summary>
public void ListCampaignActivitiesSinceDate()
{
    const string username = "apiuser-XXXXXXXXXXXX@apiconnector.com";
    const string password = "password";
    const int campaignId = 1;
    DateTime startDate = DateTime.Now - new TimeSpan(30, 0, 0, 0);    // look back a month
 
    Console.WriteLine("ListCampaignActivitiesSinceDate");
    Console.WriteLine("-------------------------------");
 
    // Get an instance to the web reference
    com.apiconnector.API api = new com.apiconnector.API();
 
    try
    {
        int currentPage = 0;   // what page are we on
        const int itemsPerPage = 5;  // the number of summaries we want to be returned for each page
 
        // execute the first get from the server
        // the select parameter is the itemsperPage, 
        // the skip is the itemsPerPage * the currentPage
        com.apiconnector.APICampaignContactSummary[] summaries = api.ListCampaignActivitiesSinceDate(username, 
                                                                                                    password, 
                                                                                                    campaignId, 
                                                                                                    startDate,
                                                                                                    itemsPerPage, 
                                                                                                    currentPage * itemsPerPage);
 
        while (summaries != null && summaries.Length > 0)
        {
            // output the current page
            Console.WriteLine("Since {0}   CurrentPage: {1}", startDate.ToShortDateString(), currentPage + 1);
 
            // display the items we have
            foreach (com.apiconnector.APICampaignContactSummary summary in summaries)
            {
                Console.WriteLine("ContactId : {0}", summary.ContactId);
                Console.WriteLine("DateFirstOpened : {0}", summary.DateFirstOpened.ToShortDateString());
                Console.WriteLine("DateLastOpened : {0}", summary.DateLastOpened.ToShortDateString());
                Console.WriteLine("DateSent : {0}", summary.DateSent.ToShortDateString());
                Console.WriteLine("Email : {0}", summary.Email);
                Console.WriteLine("FirstOpenIp : {0}", summary.FirstOpenIp);
                Console.WriteLine("FirstOpenUserAgent : {0}", summary.FirstOpenUserAgent);
                Console.WriteLine("HardBounced : {0}", summary.HardBounced);
                Console.WriteLine("NumClicks : {0}", summary.NumClicks);
                Console.WriteLine("NumEstimatedForwards : {0}", summary.NumEstimatedForwards);
                Console.WriteLine("NumForwardToFriend : {0}", summary.NumForwardToFriend);
                Console.WriteLine("NumOpens : {0}", summary.NumOpens);
                Console.WriteLine("NumReplies : {0}", summary.NumReplies);
                Console.WriteLine("NumViews : {0}", summary.NumViews);
                Console.WriteLine("SoftBounced : {0}", summary.SoftBounced);
                Console.WriteLine("Unsubscribed : {0}", summary.Unsubscribed);
                Console.WriteLine();
            }
 
            // increment the page
            currentPage++;
 
            // execute the next get - see above
            summaries = api.ListCampaignActivitiesSinceDate(username, password, campaignId, startDate, itemsPerPage, currentPage * itemsPerPage);
        }
 
        // output some stats
        Console.WriteLine("Total Pages {0}, {1} per page", currentPage, itemsPerPage);
        Console.WriteLine();
    }
    catch (SoapException ex)  // catch any soap issues/errors from the web service
    {
        Console.WriteLine("Error -> {0}", ex.Message);                
    }
 
    Console.WriteLine();
}

Sample request

POST /API.asmx HTTP/1.1
Host: apiconnector.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>

Sample response

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>

Prebuilt integrations

More about API

Address books

Contacts

Campaigns

Reporting

SMS

Account

Images

Documents

Templates