Retrieve a Triggered Send Summary

This page contains information about retrieving a summary of information associated with a triggered send via the SOAP API.

Why Retrieve a Triggered Send Summary

The triggered send summary provides more tracking information regarding a triggered send, allowing you to better understand the effectiveness of the email message being sent and make decisions based on the information.

How to Retrieve a Triggered Send Summary

Use the sample code below as a model to construct your own API code. To view information about a specific triggered send event, perform this retrieve and filter the results on the TriggeredSendDefinitionObjectID property.

Sample .NET Code

1public APIObject[] TSSummary()
2{
3            RetrieveRequest rr = new RetrieveRequest();
4            rr.ObjectType = "TriggeredSendSummary";
5            rr.Properties = new String[] { "Sent", "Bounces", "Opens", "Clicks" };
6            TriggeredSendSummary tss = new TriggeredSendSummary();
7            SimpleFilterPart sfp = new SimpleFilterPart();
8            sfp.SimpleOperator = SimpleOperators.equals;
9            sfp.Property = "CustomerKey";
10            sfp.Value = new string[] { "Weekly_Newsletter_-_2009_07_16" };
11            rr.Filter = sfp;
12            string requestID;
13
14            APIObject[] results;
15            string status = client.Retrieve(rr, out requestID, out results);
16            return results;
17}

Sample SOAP Envelope

1<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
2   <soapenv:Header>
3      <wsse:Security soapenv:mustUnderstand="1" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
4         <wsse:UsernameToken wsu:Id="UsernameToken-24440876" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
5            <wsse:Username>XXXXX</wsse:Username>
6            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">XXXXX</wsse:Password>
7         </wsse:UsernameToken>
8      </wsse:Security>
9   </soapenv:Header>
10   <soapenv:Body>
11      <RetrieveRequestMsg xmlns="http://exacttarget.com/wsdl/partnerAPI">
12         <RetrieveRequest>
13            <ObjectType>TriggeredSendSummary</ObjectType>
14            <Properties>Sent</Properties>
15            <Properties>CustomerKey</Properties>
16            <Properties>NotSentDueToOptOut</Properties>
17            <Properties>NotSentDueToUndeliverable</Properties>
18            <Properties>Bounces</Properties>
19            <Properties>Opens</Properties>
20            <Properties>Clicks</Properties>
21            <Properties>UniqueOpens</Properties>
22            <Properties>UniqueClicks</Properties>
23            <Properties>OptOuts</Properties>
24            <Properties>SurveyResponses</Properties>
25            <Properties>Conversions</Properties>
26            <Properties>UniqueConversions</Properties>
27            <Properties>InProcess</Properties>
28            <Properties>NotSentDueToError</Properties>
29            <Filter xsi:type="ns1:SimpleFilterPart" xmlns:ns1="http://exacttarget.com/wsdl/partnerAPI">
30               <Property>CustomerKey</Property>
31               <SimpleOperator>equals</SimpleOperator>
32               <Value>TESTING</Value>
33            </Filter>
34         </RetrieveRequest>
35      </RetrieveRequestMsg>
36   </soapenv:Body>
37</soapenv:Envelope>