Overview

Skill Level: Any

Prerequisites

This interface extracts metrics for a specified mailing.

Step-by-step

  1. Syntax of the request and response SOAP for GetAggregateTrackingForMailing

    Operation  <GetAggregateTrackingForMailing>     
    Elements  MAILING_ID  Required parameter specifying the Mailing ID.   
      REPORT_ID  Required parameter specifying the Report ID.   
      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:GetAggregateTrackingForMailing>
    <rep:MAILING_ID>1598295</rep:MAILING_ID>
    <rep:REPORT_ID>52054819</rep:REPORT_ID>
    <rep:TOP_DOMAIN/>
    <rep:PER_CLICK/>
    </rep:GetAggregateTrackingForMailing>
    </soapenv:Body>
    </soapenv:Envelope> 
       
    Response <RESULT>     
      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. If you do not
    include TopDomain in the request, Watson Campaign Automation will not populate this node.
     
      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 on that 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 complaint replies for
    contacts on that 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 contacts
    emails delivered to the inbox.
        Bulk Returns the number of inbox monitoring contacts
    emails delivered to the bulk folder.
        NotReceived Returns the number of inbox monitoring contacts
    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 See the example results for GetAggregateTrackingForUser.    

Join The Discussion

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