GetCampaignSummary

This method retrieves a detailed overview of a sent campaign, providing a summary of information about its performance statistics.

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

📘

Input and output parameters

The input and output parameters for this method are:

Input parameters

• Campaign ID - required; integer

Output parameters

• GetCampaignSummaryResult
  • AssistedRevenue - string
  • ConversionRate - integer
  • DateSent - dateTime
  • NumClicks - integer
  • NumDelivered - integer
  • NumEstimatedForwards - integer
  • NumForwards - integer
  • NumHardBounces - integer
  • NumIspComplaints - integer
  • NumMailBlocks - integer
  • NumOpens - integer
  • NumOrders - integer
  • NumPageViews - integer
  • NumRecipientsClicked - integer
  • NumReplies - integer
  • NumSent - integer
  • NumSoftBounces - integer
  • NumTextClicks - integer
  • NumTextDelivered - integer
  • NumTextEstimatedForwards - integer
  • NumTextForwards - integer
  • NumTextHardBounces - integer
  • NumTextIspComplaints - integer
  • NumTextMailBlocks - integer
  • NumTextOpens - integer
  • NumTextPageViews - integer
  • NumTextReplies - integer
  • NumTextSent - integer
  • NumTextSoftBounces - integer
  • NumTextUnsubscribes - integer
  • NumTotalClicks - integer
  • NumTotalDelivered - integer
  • NumTotalEstimatedForwards - integer
  • NumTotalHardBounces - integer
  • NumTotalIspComplaints - integer
  • NumTotalMailBlocks - integer
  • NumTotalOpens - integer
  • NumTotalPageViews - integer
  • NumTotalReplies - integer
  • NumTotalSent - integer
  • NumTotalSoftBounces - integer
  • NumTotalUniqueOpens - integer
  • NumTotalUnsubscribes - integer
  • NumUniqueOpens - integer
  • NumUniqueTextOpens - integer
  • NumUnsubscribes - integer
  • PercentageClicksToOpens - double
  • PercentageDelivered - double
  • PercentageHardBounces - double
  • PercentageOpens - double
  • PercentageReplies - double
  • PercentageSoftBounces - double
  • PercentageUniqueOpens - double
  • PercentageUnsubscribes - double
  • PercentageUsersClicked - double
  • Revenue - string

Example

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

	var campaignId = 1;
	var campaignSummary = client.GetCampaignSummary(campaignId);
}