Overview

Skill Level: Any

Prerequisites

This interface extracts a listing of mailings sent for an organization for a specified date range.

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 GetSentMailingsForOrg

    Operation <GetSentMailingsForOrg>       
    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”¬† ¬† ¬†
      PRIVATE  Optional parameter to retrieve private mailings. If the API does not receive a Private or Shared parameter, 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 the API does not receive a mailing type, Watson Campaign Automation will return mailings of all types.

    Watson Campaign Automation uses the various mailing type parameters 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. The SCHEDULED parameter will also include mailings in SENDING status.     
    ¬† 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 mailings that use content retrieval.     
      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:GetSentMailingsForOrg>
    <rep:DATE_START>06/01/2009 00:00:00</rep:DATE_START>
    <rep:DATE_END>07/17/2009 23:59:59</rep:DATE_END>
    <rep:SENT/>
    </rep:GetSentMailingsForOrg>
    </soapenv:Body>
    </soapenv:Envelope> 
         
    Response  <RESULT>       
    Elements  SUCCESS True if successful.     
      Mailing  XML nodes defining the instances of each mailing.     
      Child Element  MailingId  Returns the mailing ID.   
    ¬† ¬† ScheduledTS¬† Returns the scheduled date and time in the format, “mm/dd/yy
    hh:mm AMPM”
     
        MailingName  Returns the mailing name.   
        ListName  Returns the database name.   
        ListId  Returns the ID of the Database, Query ID, or Contact List that the mailing was sent to.   
        ParentListId  Returns the ID of the parent database when the mailing was sent to a Query or Contact List. If the mailing was not sent to a Query or
    Contact List, this element will be empty. 
     
    ¬† ¬† UserName¬† Returns the mailing owner’s user name.¬† ¬†
        SentTS  Returns the date and time Watson Campaign Automation sent the mailing.   
        NumSent  Returns the number of contacts to whom Watson Campaign Automation sent a mailing.   
        Subject  Returns the mailing subject.   
        Visibility  Returns visibility information about the mailing. Values are Private
    or Shared. 
     
        Tags  If INCLUDE_TAGS is specified in the request, returns any tags associated with the Sent mailing.   
          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>1902685</MailingId>
    <ReportId>55856319</ReportId>
    <ScheduledTS>2009‚Äź06‚Äź05 12:30:00.0</ScheduledTS>
    <MailingName>Scheduled Mailing</MailingName>
    <ListName>A Test List</ListName>
    <ListId>24872</ListId>
    <ParentListId>24872</ParentListId>
    <UserName>Scott Hamilton</UserName>
    <SentTS>2009‚Äź06‚Äź05 12:30:04.0</SentTS>
    <NumSent>5</NumSent>
    <Subject>Sonoa Scheduled Mailing</Subject>
    <Visibility>Shared</Visibility>
    </Mailing>
    <Mailing>
    <MailingId>1902684</MailingId>
    <ReportId>55856320</ReportId>
    <ScheduledTS>2009‚Äź06‚Äź05 12:30:00.0</ScheduledTS>
    <MailingName>Scheduled Mailing</MailingName>
    <ListName>A Test List</ListName>
    <ListId>24872</ListId>
    <ParentListId>24872</ParentListId>
    <UserName>Scott Hamilton</UserName>
    <SentTS>2009‚Äź06‚Äź05 12:30:05.0</SentTS>
    <NumSent>5</NumSent>
    <Subject>Sonoa Scheduled Mailing</Subject>
    <Visibility>Shared</Visibility>
    </Mailing>
    <Mailing>
    <MailingId>1905584</MailingId>
    <ReportId>55907260</ReportId>
    <ScheduledTS>2009‚Äź06‚Äź07 12:00:00.0</ScheduledTS>
    <MailingName>Scheduled Mailing2</MailingName>
    <ListName>A Test List</ListName>
    <ListId>24872</ListId>
    <ParentListId>24872</ParentListId>
    <UserName>Scott Hamilton</UserName>
    <SentTS>2009‚Äź06‚Äź09 06:36:16.0</SentTS>
    <NumSent>9</NumSent>
    <Subject>Sonoa Scheduled Mailing</Subject>
    <Visibility>Shared</Visibility>
    </Mailing>
    </RESULT>
    </envelope:Body>
    </envelope:Envelope> 
         

Join The Discussion

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