Overview

Skill Level: Any

Prerequisites

This interface is used to extract a listing of Watson Campaign Automation mailings that are sent for the logged on user for a specified date range.

Step-by-step

  1. Syntax of the request and response SOAP for GetAggregateTrackingForUser

    Operation <GetAggregateTrackingForUser>    
    Elements DATE_START¬† Required Starting Date in the format “mm/dd/yyyy hh:mm:ss” ¬†
    ¬† DATE_END Required Ending Date in the format “mm/dd/yyyy hh:mm:ss”¬†¬† ¬†
      OPTIONALUSER Optional User’s Email Address parameter to retrieve mailings for a user other than the current user who created the session.   
      PRIVATE  Optional parameter to retrieve private mailings. If neither private nor shared is passed to the API, Watson Campaign Automation will return both private and shared mailings.   
      SHARED  Optional parameter to retrieve shared mailings.   
    Elements  SCHEDULED  Optional Mailing Type parameter to retrieve scheduled mailings. If no mailing type is passed to the API, Watson Campaign Automation will return mailings of all types.   
      SENT Optional Mailing Type parameter to retrieve sent mailings.   
      SENDING  Optional Mailing Type parameter to retrieve mailings in the process of sending.  
    ¬† OPTIN_CONFIRMATION¬† Optional Mailing Type parameter to retrieve Opt‚Äźin Autoresponder mailings.¬† ¬†
      PROFILE_CONFIRMATION  Optional Mailing Type parameter to retrieve Edit Profile Autoresponder mailings.  
      AUTOMATED  Optional Mailing Type parameter to retrieve Custom Autoresponder mailings.   
      CAMPAIGN_ACTIVE  Optional Mailing Type parameter to retrieve active Groups of Automated Messages.  
      CAMPAIGN_COMPLETED  Optional Mailing Type parameter to retrieve completed Groups of Automated Messages.   
      CAMPAIGN_CANCELLED  Optional Mailing Type parameter to retrieve canceled Groups of Automated Messages.   
      TOP_DOMAIN  Optional parameter requesting top domain statistics for each mailing.   
      INBOX_MONITORING Optional parameter requesting Inbox Monitoring statistics for each mailing.   
      PER_CLICK  Optional parameter requesting the total clicks for each link in the mailing by Body Type.   
    Example¬† <soapenv:Envelope xmlns:soapenv=”http://schemas.xmlsoap.org/soap/envelope/”
    xmlns:ses=”SilverpopApi:EngageService.SessionHeader”
    xmlns:rep=”SilverpopApi:EngageService.Reporting”>
    <soapenv:Header>
    <ses:sessionHeader>
    <ses:sessionid>16FE7B75445E6C704707025B1B7BBEE5</ses:sessionid>
    </ses:sessionHeader>
    </soapenv:Header>
    <soapenv:Body>
    <rep:GetAggregateTrackingForUser>
    <rep:DATE_START>04/01/2009 00:00:00</rep:DATE_START>
    <rep:DATE_END>05/28/2009 23:59:59</rep:DATE_END>
    <rep:PRIVATE/>
    <rep:SENT/>
    <rep:TOP_DOMAIN/>
    <rep:PER_CLICK/>
    </rep:GetAggregateTrackingForUser>
    </soapenv:Body>
    </soapenv:Envelope>
       
    Response  <RESULT>     
    Elements  SUCCESS  True if successful.   
      Mailing  XML nodes defining the instances of the sent mailing.   
      Child Element  MailingId  Returns the Mailing ID. 
        ReportId  Returns the Report ID. 
        MailingName Returns the mailing name. 
        SentDateTime  Returns the date and time Watson Campaign Automation sent the mailing. 
        NumSent  Returns the number of contacts to whom Watson Campaign Automation sent the
    mailing. 
        NumSeeds Returns the number of contacts seeded into the mailing. 
        NumSuppressed  Returns the number of contacts suppressed from the
    mailing. 
        NumInboxMonitored  Returns the number of Inbox Monitoring addresses seeded into this mailing.
        NumBounceHard Returns the number of hard bounces. 
        NumBounceSoft  Returns the number of soft bounces. 
        NumUniqueOpen  Returns the number of unique opens. 
        NumGrossOpen  Returns the number of gross opens.
        NumUniqueClick Returns the number of unique clicks. 
        NumGrossClick  Returns the number of gross clicks. 
        NumUniqueAttach  Returns the number of unique attachment downloads. 
        NumGrossAttach  Returns the number of gross attachment downloads. 
        NumUniqueClickstreams  Returns the number of unique clickstream clicks. 
        NumGrossClickstreams  Returns the number of gross clickstream clicks. 
        NumUniqueMedia  Returns the number of unique media plays. 
        NumGrossMedia  Returns the number of gross media plays. 
        NumGrossAbuse  Returns the number of abuse complaints. 
        NumGrossChangeAddress  Returns the number of change of address replies. 
        NumGrossMailBlock  Returns the number of mail block replies. 
        NumGrossMailRestriction  Returns the number of mail restriction replies. 
        NumGrossOther  Returns the number of other replies. 
        NumConversions  Returns the number of conversions. 
        NumConversionAmount  Returns the total conversion amount. 
        NumBounceHardFwd  Returns the number of hard bounces that occurred for forwarded contacts. 
        NumBounceSoftFwd  Returns the number of soft bounces that occurred for forwarded contacts. 
        NumConversionAmountFwd  Returns the total conversion amount that occurred for
    forwarded contacts. 
        NumClickFwd  Returns the number of clicks for forwarded contacts. 
        NumUniqueForwardFwd  Returns the number of unique forwards by forwarded
    contacts. 
        NumGrossForwardFwd  Returns the number of gross forwards by forwarded
    contacts. 
        NumUniqueConversionsFwd Returns the number of unique conversions by forwarded
    contacts. 
        NumGrossConversionsFwd  Returns the number of gross conversions by forwarded
    contacts. 
        NumUniqueClickstreamFwd  Returns the number of unique clickstream clicks by
    forwarded contacts. 
        NumGrossClickstreamFwd  Returns the number of gross clickstream clicks by
    forwarded contacts. 
        NumUniqueClickFwd  Returns the number of unique clicks by forwarded
    contacts. 
        NumGrossClickFwd Returns the number of gross clicks by forwarded contacts.
        NumUniqueAttachOpenFwd  Returns the number of unique attachment downloads by
    forwarded contacts. 
        NumGrossAttachOpenFwd  Returns the number of gross attachment downloads by
    forwarded contacts. 
        NumUniqueMediaFwd  Returns the number of unique media plays by forwarded
    contacts. 
        NumGrossMediaFwd  Returns the number of gross media plays by forwarded
    contacts. 
        NumUniqueOpenFwd  Returns the number of unique opens by forwarded
    contacts. 
        NumGrossOpenFwd  Returns the number of gross opens by forwarded
    contacts. 
        NumAbuseFwd  Returns the number of abuse complaints by forwarded
    contacts. 
        NumChangeAddressFwd  Returns the number of change address replies by
    forwarded contacts. 
        NumMailRestrictionFwd  Returns the number of mail restriction replies by
    forwarded contacts. 
        NumMailBlockFwd  Returns the number of mail block replies by forwarded
    contacts. 
        NumOtherFwd  Returns the number of other replies by forwarded
    contacts. 
        NumSuppressedFwd  Returns the number of suppressed forwards. 
      TopDomain XML nodes defining top domain reporting for the sent mailings. Node not
    populated if the option is not included in the request.
     
      Child Element  MailingId Returns the Mailing ID. 
        ReportId  Returns the Report ID. 
        Domain  Returns the domain name. 
        Sent  Returns the number of contacts sent for the domain. 
        Bounce  Returns the number of bounces for the domain. 
        Open  Returns the number of opens for contacts.of the domain. 
        Click  Returns the number of clicks for contacts.of the domain. 
        Unsubscribe  Returns the number of unsubscribe requests for
    contacts.of the domain. 
        Conversion  Returns the number of conversions for contacts of the domain. 
        Conversion_Amount  Returns the total conversion amount for contacts of the domain 
        Reply_abuse  Returns the number of abuse complain replies for
    contacts of the domain. 
        Reply_mail_block Returns the number of mail block replies for contacts of
    the domain. 
        Reply_mail_restriction  Returns the number of mail restriction replies for
    contacts of the domain.
      InboxMonitored XML nodes defining inbox monitoring reporting for the sent mailings. Child
    nodes will be encapsulated in a “InboxMonitoring” Node. This node will not
    be populated if the option is not included in the request.
     
      Child Element MailingId Returns the Mailing ID.
        ReportId Returns the Report ID.
        Domain Returns the domain name.
        Sent Returns the number of inbox monitoring contacts.sent for the domain.
        Inbox Returns the number of inbox monitoring contact.emails
    delivered to the inbox.
        Bulk Returns the number of inbox monitoring contact emails
    delivered to the bulk folder.
        NotReceived Returns the number of inbox monitoring contact emails
    not delivered.
      Clicks XML nodes listing tracking information for tracked hyperlinks. Child nodes
    encapsulated in a “Click” Node. Not populated if the option is not included in
    the request.
     
      Child Element MailingId Returns the Mailing ID.
        ReportId Returns the Report ID.
        LinkName Returns the link Name.
        LinkURL Returns the link URL.
        TotalHTML Returns the number of clicks on the link in the HTML body.
        TotalAOL Returns the number of clicks on the link in the AOL body.
        TotalWEB Returns the number of clicks on the link in the WEB body.
        TotalTEXT Returns the number of clicks on the link in the TEXT body.
    Example <envelope:Envelope xmlns=”SilverpopApi:EngageService.Reporting”
    xmlns:envelope=”http://schemas.xmlsoap.org/soap/envelope/”>
    <envelope:Header/>
    <envelope:Body>
    <RESULT>
    <SUCCESS>TRUE</SUCCESS>
    <Mailing>
    <MailingId>1598295</MailingId>
    <ReportId>52054819</ReportId>
    <MailingName>DLL Mailing 2 (3)</MailingName>
    <SentDateTime>2009‚Äź05‚Äź01 16:56:49.0</SentDateTime>
    <NumSent>2</NumSent>
    <NumSeeds>0</NumSeeds>
    <NumSuppressed>0</NumSuppressed>
    <NumInboxMonitored>19</NumInboxMonitored>
    <NumBounceHard>0</NumBounceHard>
    <NumBounceSoft>0</NumBounceSoft>
    <NumUniqueOpen>1</NumUniqueOpen>
    <NumGrossOpen>3</NumGrossOpen>
    <NumUniqueClick>1</NumUniqueClick>
    <NumGrossClick>1</NumGrossClick>
    <NumUniqueAttach>0</NumUniqueAttach>
    <NumGrossAttach>0</NumGrossAttach>
    <NumUniqueClickstreams>0</NumUniqueClickstreams>
    <NumGrossClickstreams>0</NumGrossClickstreams>
    <NumUniqueMedia>0</NumUniqueMedia>
    <NumGrossMedia>0</NumGrossMedia>
    <NumGrossAbuse>0</NumGrossAbuse>
    <NumGrossChangeAddress>0</NumGrossChangeAddress>
    <NumGrossMailBlock>0</NumGrossMailBlock>
    <NumGrossMailRestriction>0</NumGrossMailRestriction>
    <NumGrossOther>0</NumGrossOther>
    <NumConversions>0</NumConversions>
    <NumConversionAmount>0</NumConversionAmount>
    <NumBounceHardFwd>0</NumBounceHardFwd>
    <NumBounceSoftFwd>0</NumBounceSoftFwd>
    <NumConversionAmountFwd>0</NumConversionAmountFwd>
    <NumAttachOpenFwd>0</NumAttachOpenFwd>
    <NumClickFwd>0</NumClickFwd>
    <NumUniqueForwardFwd>0</NumUniqueForwardFwd>
    <NumGrossForwardFwd>0</NumGrossForwardFwd>
    <NumUniqueConversionsFwd>0</NumUniqueConversionsFwd>
    <NumGrossConversionsFwd>0</NumGrossConversionsFwd>
    <NumUniqueClickstreamFwd>0</NumUniqueClickstreamFwd>
    <NumGrossClickstreamFwd>0</NumGrossClickstreamFwd>
    <NumUniqueClickFwd>0</NumUniqueClickFwd>
    <NumGrossClickFwd>0</NumGrossClickFwd>
    <NumUniqueAttachOpenFwd>0</NumUniqueAttachOpenFwd>
    <NumGrossAttachOpenFwd>0</NumGrossAttachOpenFwd>
    <NumUniqueMediaFwd>0</NumUniqueMediaFwd>
    <NumGrossMediaFwd>0</NumGrossMediaFwd>
    <NumUniqueOpenFwd>0</NumUniqueOpenFwd>
    <NumGrossOpenFwd>0</NumGrossOpenFwd>
    <NumAbuseFwd>0</NumAbuseFwd>
    <NumChangeAddressFwd>0</NumChangeAddressFwd>
    <NumMailRestrictionFwd>0</NumMailRestrictionFwd>
    <NumMailBlockFwd>0</NumMailBlockFwd>
    <NumOtherFwd>0</NumOtherFwd>
    <NumSuppressedFwd>0</NumSuppressedFwd>
    </Mailing>
    <TopDomains>
    <TopDomain>
    <MailingId>1598295</MailingId>
    <ReportId>52054819</ReportId>
    <Domain>gmail.com</Domain>
    <Sent>1</Sent>
    <Bounce>0</Bounce>
    <Open>0</Open>
    <Click>0</Click>
    <Unsubscribe>0</Unsubscribe>
    <Conversion>0</Conversion>
    <Conversion_amount>0</Conversion_amount>
    <Reply_abuse>0</Reply_abuse>
    <Reply_mail_block>0</Reply_mail_block>
    <Reply_mail_restriction>0</Reply_mail_restriction>
    </TopDomain>
    <TopDomain>
    <MailingId>1598295</MailingId>
    <ReportId>52054819</ReportId>
    <Domain>silverpop.com</Domain>
    <Sent>1</Sent>
    <Bounce>0</Bounce>
    <Open>3</Open>
    <Click>1</Click>
    <Unsubscribe>0</Unsubscribe>
    <Conversion>0</Conversion>
    <Conversion_amount>0</Conversion_amount>
    <Reply_abuse>0</Reply_abuse>
    <Reply_mail_block>0</Reply_mail_block>
    <Reply_mail_restriction>0</Reply_mail_restriction>
    </TopDomain>
    </TopDomains>
    <Clicks>
    <Click>
    <MailingId>1598295</MailingId>
    <ReportId>52054819</ReportId>
    <LinkName>dll_link</LinkName>
    <TotalHTML>1</TotalHTML>
    <TotalAOL>0</TotalAOL>
    <TotalWEB>0</TotalWEB>
    <TotalTEXT>0</TotalTEXT>
    </Click>
    </Clicks>
    </RESULT>
    </envelope:Body>
    </envelope:Envelope>
       

Join The Discussion

Your email address will not be published. Required fields are marked *