List campaign contact page views

The ListCampaignContactPageViews method to retrieve a list of stats about page views generated by a campaign for a contact.

If you have enabled dotMailer page tracking on your website, you can use this method to find out which pages a contact went on to view as a result of clicking a link in your campaign. Use this to see the contact‑s trail through your website.

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�@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
contactId	int	This is the ID of the contact 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 APICampaignContactPageView objects, each consisting of the following:

url	string	The URL tracked as having been visited.
dateViewed	dateTime	The date and time the page view was tracked.

Error responses

ERROR_CAMPAIGN_INVALID
ERROR_CAMPAIGN_NOT_FOUND
ERROR_CONTACT_INVALID
ERROR_CONTACT_NOT_FOUND
ERROR_CONTACT_SUPPRESSED
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/ListCampaignContactPageViews"

Example of use in C# .NET

/// <summary>
/// Retrieves a list of page views for a contact relating to a specified campaign. 
/// </summary>
public void ListCampaignContactPageViews()
{
    const string username = "apiuser-XXXXXXXXXXXX@apiconnector.com";
    const string password = "password";
    const int campaignId = 1;
    const int contactId = 1;
 
    Console.WriteLine("ListCampaignContactPageViews");
    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 clickers we want to be returned for each page
                                     // This number must be LESS than 1000   
 
        // execute the first get from the server
        // the select parameter is the itemsperPage, 
        // the skip is the itemsPerPage * the currentPage
        com.apiconnector.APICampaignContactPageView [] views = api.ListCampaignContactPageViews(username, password, campaignId, contactId, itemsPerPage, currentPage * itemsPerPage);
 
        while (views != null && views.Length > 0)
        {
            // output the current page
            Console.WriteLine("CurrentPage: {0}", currentPage + 1);
 
            foreach (com.apiconnector.APICampaignContactPageView view in views)
            {
                Console.WriteLine("dateViewed : {0}", view.dateViewed);
                Console.WriteLine("URL : {0}", view.url );
                Console.WriteLine();
            }
 
            // increment the page
            currentPage++;
 
            // execute the next get - see above
            views = api.ListCampaignContactPageViews(username, password, campaignId, contactId, 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/ListCampaignContactPageViews"
<?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>
    <ListCampaignContactPageViews xmlns="http://apiconnector.com">
      <username>string</username>
      <password>string</password>
      <campaignId>int</campaignId>
      <contactId>int</contactId>
      <select>int</select>
      <skip>int</skip>
    </ListCampaignContactPageViews>
  </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>
    <ListCampaignContactPageViewsResponse xmlns="http://apiconnector.com">
      <ListCampaignContactPageViewsResult>
        <APICampaignContactPageView>
          <url>string</url>
          <dateViewed>dateTime</dateViewed>
        </APICampaignContactPageView>
        <APICampaignContactPageView>
          <url>string</url>
          <dateViewed>dateTime</dateViewed>
        </APICampaignContactPageView>
      </ListCampaignContactPageViewsResult>
    </ListCampaignContactPageViewsResponse>
  </soap:Body>
</soap:Envelope>

Prebuilt integrations

More about API

Address books

Contacts

Campaigns

Reporting

SMS

Account

Images

Documents

Templates