GetCampaignSummary

Gets a summary of reporting information for a specified campaign

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

Example

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

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