Overview

Skill Level: Any

Prerequisites

This interface extracts a listing of mailings sent for a particular database and specified date range. It allows specification of a Database or Query ID as well as a flag to include ‚Äúchildren.‚ÄĚ

Note: The Watson Campaign Automation user account calling the API must have Organization Administration rights.

Step-by-step

  1. Syntax of the request and response SOAP for GetSentMailingsForList

    Operation <GetSentMailingsForList>       
    Elements  LIST_ID  Required ID of the Database or Query for which to retrieve mailings.     
      INCLUDE_CHILDREN Optional parameter to retrieve mailings for queries based on the specified Database ID.     
    ¬† 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”¬† ¬† ¬†
      PRIVATE Optional parameter to retrieve private mailings. If the API does not receive private or shared designation, Watson Campaign Automation will return both private and shared mailings.     
      SHARED Optional parameter to retrieve shared mailings.     
      SCHEDULED Optional mailing type parameter to retrieve scheduled mailings. If you do not specify a mailing type in the API, Watson Campaign Automation will return mailings of all types; the various mailing type parameters are used to limit the list to only the specified 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.     
      CAMPAIGN_SCRAPE_TEMPLATE  Optional Mailing Type parameter to retrieve Campaign Scrape Template mailings.    
      INCLUDE_TAGS  Optional parameter to return all Tags associated with the Sent mailing.     
      EXCLUDE_ZERO_SENT  Optional parameter to exclude mailings with no contacts.     
    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:GetSentMailingsForList>
    <rep:LIST_ID>23892</rep:LIST_ID>
    <rep:INCLUDE_CHILDREN/>
    <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:GetSentMailingsForList>
    </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.   
    ¬† ¬† ScheduledTS¬† Returns the scheduled date and time in the following format: “mm/dd/yy
    hh:mm AMPM”¬†
     
        MailingName  Returns the mailing name.   
        ListName  Returns the database name.  
        ListId  Returns the database ID.   
        UserName  Returns the user name for the mailing owner.   
        SentTS  Returns the date/time when Watson Campaign Automation sent the mailing.   
        NumSent  Returns the number of contacts to whom Watson Campaign Automation sent the mailing.   
        Subject  Returns the mailing subject.   
    Elements   Visibility  Returns the visibility of the mailing (Shared or Private).   
        QueryId  Returns the query ID if the mailing was sent to a query.  
        QueryName  Returns the query name if the mailing was sent to a query.   
        Tags  Returns any tags associated with the Sent mailing if you specified
    INCLUDE_TAGS in the request. 
     
          Tag XML nodes containing the Tags associated with the
    Sent mailing.
    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>
    <ScheduledTS>2009‚Äź05‚Äź01 16:56:43.0</ScheduledTS>
    <MailingName>DLL Mailing 2 (3)</MailingName>
    <ListName>sbh_test_aat</ListName>
    <ListId>23892</ListId>
    <ParentListId>23892</ParentListId>
    <UserName>Scott Hamilton</UserName>
    <SentTS>2009‚Äź05‚Äź01 16:56:49.0</SentTS>
    <NumSent>2</NumSent>
    <Subject>DLL Mailing 2</Subject>
    <Visibility>Private</Visibility>
    </Mailing>
    </RESULT>
    </envelope:Body>
    </envelope:Envelope> 
         

Join The Discussion

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