API
Click here for a complete list of operations.
GetCampaignSummary
Gets a summary of reporting information for a specified campaign.
Test
The test form is only available for requests from the local machine.SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
POST /api.asmx HTTP/1.1 Host: r1-api.dotdigital.com Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "http://apiconnector.com/GetCampaignSummary" <?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> <GetCampaignSummary xmlns="http://apiconnector.com"> <username>string</username> <password>string</password> <campaignId>int</campaignId> </GetCampaignSummary> </soap:Body> </soap:Envelope>
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> <GetCampaignSummaryResponse xmlns="http://apiconnector.com"> <GetCampaignSummaryResult> <NumUniqueOpens>int</NumUniqueOpens> <NumUniqueTextOpens>int</NumUniqueTextOpens> <NumTotalUniqueOpens>int</NumTotalUniqueOpens> <NumOpens>int</NumOpens> <NumTextOpens>int</NumTextOpens> <NumTotalOpens>int</NumTotalOpens> <NumClicks>int</NumClicks> <NumTextClicks>int</NumTextClicks> <NumTotalClicks>int</NumTotalClicks> <NumPageViews>int</NumPageViews> <NumTotalPageViews>int</NumTotalPageViews> <NumTextPageViews>int</NumTextPageViews> <NumForwards>int</NumForwards> <NumTextForwards>int</NumTextForwards> <NumEstimatedForwards>int</NumEstimatedForwards> <NumTextEstimatedForwards>int</NumTextEstimatedForwards> <NumTotalEstimatedForwards>int</NumTotalEstimatedForwards> <NumReplies>int</NumReplies> <NumTextReplies>int</NumTextReplies> <NumTotalReplies>int</NumTotalReplies> <NumHardBounces>int</NumHardBounces> <NumTextHardBounces>int</NumTextHardBounces> <NumTotalHardBounces>int</NumTotalHardBounces> <NumSoftBounces>int</NumSoftBounces> <NumTextSoftBounces>int</NumTextSoftBounces> <NumTotalSoftBounces>int</NumTotalSoftBounces> <NumUnsubscribes>int</NumUnsubscribes> <NumTextUnsubscribes>int</NumTextUnsubscribes> <NumTotalUnsubscribes>int</NumTotalUnsubscribes> <NumISPComplaints>int</NumISPComplaints> <NumTextISPComplaints>int</NumTextISPComplaints> <NumTotalISPComplaints>int</NumTotalISPComplaints> <NumMailBlocks>int</NumMailBlocks> <NumTextMailBlocks>int</NumTextMailBlocks> <NumTotalMailBlocks>int</NumTotalMailBlocks> <NumSent>int</NumSent> <NumTextSent>int</NumTextSent> <NumTotalSent>int</NumTotalSent> <NumRecipientsClicked>int</NumRecipientsClicked> <NumDelivered>int</NumDelivered> <NumTextDelivered>int</NumTextDelivered> <NumTotalDelivered>int</NumTotalDelivered> <DateSent>dateTime</DateSent> <PercentageDelivered>double</PercentageDelivered> <PercentageUniqueOpens>double</PercentageUniqueOpens> <PercentageOpens>double</PercentageOpens> <PercentageUnsubscribes>double</PercentageUnsubscribes> <PercentageReplies>double</PercentageReplies> <PercentageHardBounces>double</PercentageHardBounces> <PercentageSoftBounces>double</PercentageSoftBounces> <PercentageUsersClicked>double</PercentageUsersClicked> <PercentageClicksToOpens>double</PercentageClicksToOpens> </GetCampaignSummaryResult> </GetCampaignSummaryResponse> </soap:Body> </soap:Envelope>
SOAP 1.2
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
POST /api.asmx HTTP/1.1 Host: r1-api.dotdigital.com Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <GetCampaignSummary xmlns="http://apiconnector.com"> <username>string</username> <password>string</password> <campaignId>int</campaignId> </GetCampaignSummary> </soap12:Body> </soap12:Envelope>
HTTP/1.1 200 OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <GetCampaignSummaryResponse xmlns="http://apiconnector.com"> <GetCampaignSummaryResult> <NumUniqueOpens>int</NumUniqueOpens> <NumUniqueTextOpens>int</NumUniqueTextOpens> <NumTotalUniqueOpens>int</NumTotalUniqueOpens> <NumOpens>int</NumOpens> <NumTextOpens>int</NumTextOpens> <NumTotalOpens>int</NumTotalOpens> <NumClicks>int</NumClicks> <NumTextClicks>int</NumTextClicks> <NumTotalClicks>int</NumTotalClicks> <NumPageViews>int</NumPageViews> <NumTotalPageViews>int</NumTotalPageViews> <NumTextPageViews>int</NumTextPageViews> <NumForwards>int</NumForwards> <NumTextForwards>int</NumTextForwards> <NumEstimatedForwards>int</NumEstimatedForwards> <NumTextEstimatedForwards>int</NumTextEstimatedForwards> <NumTotalEstimatedForwards>int</NumTotalEstimatedForwards> <NumReplies>int</NumReplies> <NumTextReplies>int</NumTextReplies> <NumTotalReplies>int</NumTotalReplies> <NumHardBounces>int</NumHardBounces> <NumTextHardBounces>int</NumTextHardBounces> <NumTotalHardBounces>int</NumTotalHardBounces> <NumSoftBounces>int</NumSoftBounces> <NumTextSoftBounces>int</NumTextSoftBounces> <NumTotalSoftBounces>int</NumTotalSoftBounces> <NumUnsubscribes>int</NumUnsubscribes> <NumTextUnsubscribes>int</NumTextUnsubscribes> <NumTotalUnsubscribes>int</NumTotalUnsubscribes> <NumISPComplaints>int</NumISPComplaints> <NumTextISPComplaints>int</NumTextISPComplaints> <NumTotalISPComplaints>int</NumTotalISPComplaints> <NumMailBlocks>int</NumMailBlocks> <NumTextMailBlocks>int</NumTextMailBlocks> <NumTotalMailBlocks>int</NumTotalMailBlocks> <NumSent>int</NumSent> <NumTextSent>int</NumTextSent> <NumTotalSent>int</NumTotalSent> <NumRecipientsClicked>int</NumRecipientsClicked> <NumDelivered>int</NumDelivered> <NumTextDelivered>int</NumTextDelivered> <NumTotalDelivered>int</NumTotalDelivered> <DateSent>dateTime</DateSent> <PercentageDelivered>double</PercentageDelivered> <PercentageUniqueOpens>double</PercentageUniqueOpens> <PercentageOpens>double</PercentageOpens> <PercentageUnsubscribes>double</PercentageUnsubscribes> <PercentageReplies>double</PercentageReplies> <PercentageHardBounces>double</PercentageHardBounces> <PercentageSoftBounces>double</PercentageSoftBounces> <PercentageUsersClicked>double</PercentageUsersClicked> <PercentageClicksToOpens>double</PercentageClicksToOpens> </GetCampaignSummaryResult> </GetCampaignSummaryResponse> </soap12:Body> </soap12:Envelope>