GetCampaignClicks

Gets a list of campaign link clicks

This method returns a list of clicks for links within a specified campaign.

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/GetCampaignClicks

πŸ“˜

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

  • GetCampaignClicksResult - *array of CampaignContactClick
    • CampaignContactClick
      • ContactId - integer
      • Email - string
      • Url - string
      • IpAddress - string
      • UserAgent - string
      • DateClicked - dateTime
      • Keyword - string

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 campaignClicks = client.GetCampaignClicks(campaignId, select, skip);
}