List campaign openers

The ListCampaignOpeners method returns a list of openers for a specified campaign. It will provide information on the openers email address, email client used to open the email and the version of that email client.

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.

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‑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
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 APICampaignContactOpen2 objects, each consisting of the following:

email	string	The email address of the contact.
mailClient	string	The mail client used to open the email.
mailClientVersion	string	The version of the mail client used to open the email.
ipAddress	string	The IP address that the contact was using when they clicked the link.
userAgent	string	The user agent the contact was using the read the email when the link was clicked.
isHtml	boolean	Whether the campaign opened was the HTML one (TRUE) or Plain Text one (FALSE).
isForward	boolean	Whether the open was from a forwarded campaign..
dateOpened	dateTime	The date and time the link was opened.

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/ListCampaignOpeners"

Example of use in C# .NET

/// <summary>
/// This method gets a list of openers for a specified campaign
/// </summary>
public void ListCampaignOpeners()
{
    const string username = "apiuser-XXXXXXXXXXXX@apiconnector.com";
    const string password = "password";
    const int campaignId = 1;
 
    Console.WriteLine("ListCampaignOpeners");
    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 items 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.APICampaignContactOpen2 [] openers = api.ListCampaignOpeners(username, password, campaignId, itemsPerPage, currentPage * itemsPerPage);
 
        // make sure we have some data to work with
        while (openers != null && openers.Length > 0)
        {
            // output the current page
            Console.WriteLine("CurrentPage: {0}", currentPage + 1);
 
            foreach (com.apiconnector.APICampaignContactOpen2 opener in openers)
            {
                Console.WriteLine("Email : {0}", opener.Email);
                Console.WriteLine("MailClient : {0}", opener.MailClient);
                Console.WriteLine("MailClientVersion : {0}", opener.MailClientVersion);
                Console.WriteLine("dateOpened : {0}", opener.dateOpened.ToShortDateString());
                Console.WriteLine("ipAddress : {0}", opener.ipAddress);
                Console.WriteLine("isForward : {0}", opener.isForward);
                Console.WriteLine("isHtml : {0}", opener.isHtml);
                Console.WriteLine("userAgent : {0}", opener.userAgent);
 
                Console.WriteLine();
            }
 
            // increment the page
            currentPage++;
 
            // execute the next get - see above
            openers = api.ListCampaignOpeners(username, password, campaignId, 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/ListCampaignOpeners"
<?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>
    <ListCampaignOpeners xmlns="http://apiconnector.com">
      <username>string</username>
      <password>string</password>
      <campaignId>int</campaignId>
      <select>int</select>
      <skip>int</skip>
    </ListCampaignOpeners>
  </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>
    <ListCampaignOpenersResponse xmlns="http://apiconnector.com">
      <ListCampaignOpenersResult>
        <APICampaignContactOpen2>
          <Email>string</Email>
          <MailClient>string</MailClient>
          <MailClientVersion>string</MailClientVersion>
        </APICampaignContactOpen2>
        <APICampaignContactOpen2>
          <Email>string</Email>
          <MailClient>string</MailClient>
          <MailClientVersion>string</MailClientVersion>
        </APICampaignContactOpen2>
      </ListCampaignOpenersResult>
    </ListCampaignOpenersResponse>
  </soap:Body>
</soap:Envelope>

Prebuilt integrations

More about API

Address books

Contacts

Campaigns

Reporting

SMS

Account

Images

Documents

Templates