Overview

Skill Level: Any

Prerequisites

This interface extracts a listing of mailings sent for the logged on user for a specified date range. If using the OPTIONALUSER parameter, an Org Admin can specify a different user’s mailings instead.

Step-by-step

  1. Syntax of the request and response SOAP for GetSentMailingsForUser

    Operation  <GetSentMailingsForUser>       
    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 the API does not receive a 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. Watson Campaign Automation returns mailings of all types when the API does not receive a mailing type designation.     
      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:GetSentMailingsForUser>
    <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:SENT/>
    </rep:GetSentMailingsForUser>
    </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.   
    ¬† ¬† 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 ID of the database or query that the mailing
    was sent to. 
     
        ParentListId  Returns the ID of the parent database when the mailing was sent to a query. If the mailing was not sent to a query, this element will be empty.   
        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.   
        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>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>
    <Mailing>
    <MailingId>1555587</MailingId>
    <ReportId>52043019</ReportId>
    <ScheduledTS>2009‚Äź04‚Äź28 11:04:42.0</ScheduledTS>
    <MailingName>Sample Mailing (1)</MailingName>
    <ListName>CM_List</ListName>
    <ListId>20274</ListId>
    <ParentListId>20274</ParentListId>
    <UserName>Scott Hamilton</UserName>
    <SentTS>2009‚Äź04‚Äź28 11:04:47.0</SentTS>
    <NumSent>2</NumSent>
    <Subject>Testing Link name Pers.</Subject>
    <Visibility>Private</Visibility>
    </Mailing>
    </RESULT>
    </envelope:Body>
    </envelope:Envelope> 
         

Join The Discussion

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