List campaign contact roi detail since date

The ListCampaignContactRoiDetailSinceDate method to retrieve ROI information for all contacts affected by a specific campaign.

You may request 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
sinceDate	dateTime	This is the dateTime that you would like to begin selecting Campaigns from (server time).	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 APICampaignRoiDetail objects, each consisting of the following:

contactID	int	The ID of the contact sent the campaign that triggered the ROI activity.
marker	string	The first parameter of the _dmTrack() function.
type	string	The datatype of the value.
value	string	The second parameter of the _dmTrack() function.
dateEntered	dateTime	The date and time the tracking code was triggered.

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

Example of use in C# .NET

/// <summary>
/// This method can be used to retrieve ROI information for all contacts affected by a specific campaign.
/// </summary>
public void ListCampaignRoiDetailSinceDate()
{
    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);      // 30 days in the past
 
    Console.WriteLine("ListCampaignRoiDetailSinceDate");
    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 no greater than 5
 
        // execute the first get from the server
        // the select parameter is the itemsperPage, 
        // the skip is the itemsPerPage * the currentPage
        com.apiconnector.APICampaignROIDetail[] details = api.ListCampaignRoiDetailSinceDate(username, password, campaignId, startDate, itemsPerPage, currentPage * itemsPerPage);
 
        while (details != null && details.Length > 0)
        {
            // output the current page
            Console.WriteLine("CurrentPage: {0}", currentPage + 1);
 
            foreach (com.apiconnector.APICampaignROIDetail detail in details)
            {
                Console.WriteLine("contactId : {0}", detail.contactId);
                Console.WriteLine("dateEntered : {0}", detail.dateEntered.ToShortDateString());
                Console.WriteLine("marker : {0}", detail.marker);
                Console.WriteLine("type : {0}", detail.type);
                Console.WriteLine("value : {0}", detail.value);
 
                Console.WriteLine();
            }
 
            // increment the page
            currentPage++;
 
            // execute the next get - see above
            details = api.ListCampaignRoiDetailSinceDate(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/ListCampaignRoiDetailSinceDate"
<?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>
    <ListCampaignRoiDetailSinceDate xmlns="http://apiconnector.com">
      <username>string</username>
      <password>string</password>
      <campaignId>int</campaignId>
      <sinceDate>dateTime</sinceDate>
      <select>int</select>
      <skip>int</skip>
    </ListCampaignRoiDetailSinceDate>
  </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>
    <ListCampaignRoiDetailSinceDateResponse xmlns="http://apiconnector.com">
      <ListCampaignRoiDetailSinceDateResult>
        <APICampaignROIDetail>
          <contactId>int</contactId>
          <marker>string</marker>
          <type>string</type>
          <value>string</value>
          <dateEntered>dateTime</dateEntered>
        </APICampaignROIDetail>
        <APICampaignROIDetail>
          <contactId>int</contactId>
          <marker>string</marker>
          <type>string</type>
          <value>string</value>
          <dateEntered>dateTime</dateEntered>
        </APICampaignROIDetail>
      </ListCampaignRoiDetailSinceDateResult>
    </ListCampaignRoiDetailSinceDateResponse>
  </soap:Body>
</soap:Envelope>

About the API

Address books

Contacts

Campaigns

Reporting

SMS

Account

Images

Documents

Templates