GetCampaignOpens

Gets a list of campaign opens

This method returns a list of openers for a specified campaign, providing detailed information such as the email client used to open the email and the version of that email client.

The select parameter requires a number between 1 and 1000 (0 is not a valid number). You may only select a maximum of 1000 results in a single request.

The skip parameter should be used in tandem with the select parameter when wanting to iterate through a whole data set. If you want to select the next 1000 records you should set the select parameter to 1000 and the skip parameter to 1000, which will return records 1001 to 2000. You should continue to do this until 0 records are returned to retrieve the whole data set.

SOAP action: http://apiconnector.com/v2/ApiService/GetCampaignOpens

πŸ“˜

Input and output parameters

The input and output parameters for this method are:

Input parameters

  • Campaign ID - required; integer
  • Select - optional; integer
  • Skip - optional; integer

Output parameters

  • GetCampaignOpensResult - array of CampaignContactOpen
    • CampaignContactOpen
      • ContactId - integer
      • Email - string
      • MailClient - string
      • MailClientVersion - string
      • IpAddress - string
      • UserAgent - string
      • IsHtml - boolean
      • IsForward - boolean (deprecated, and value will always show as 'false')
      • DateOpened - dateTime

Example

using (var client = new ApiServiceClient())
{
	client.ClientCredentials.UserName.UserName = "username";
	client.ClientCredentials.UserName.Password = "password";

	var campaignId = 1;
	var select = 1000;
	var skip = 0;
	
	var campaignOpens = client.GetCampaignOpens(campaignId, select, skip);
}