API reference
Help CenterCommunityDevelopersAcademyStatus

Get a list of emails sent for an organization - GetSentMailingsForOrg

Extracts a listing of Acoustic Campaign emails that are sent for an organization from a specific date range.

📘

The Acoustic Campaign user account that calls the API must have Organization Administration rights.

Elements (Required)

DATE_START - The starting date of your range in the format “mm/dd/yyyy hh:mm:ss”

DATE_END - The ending date of your range in the format “mm/dd/yyyy hh:mm:ss”

Elements (Optional)

PRIVATE - Retrieves private emails. If the API does not receive a Private or Shared element, Acoustic Campaign returns both private and shared emails.

SHARED - Retrieves shared emails.

SCHEDULED - Retrieves scheduled emails. If the API does not receive an email type, Acoustic Campaign returns emails of all types. Acoustic Campaign uses the various email type elements to limit the list to only the specified types.

SENT - Retrieves sent emails.

SENDING - Retrieve emails that are sending. The SCHEDULED element includes emails in the SENDING status.

OPTIN_CONFIRMATION - Retrieves Opt-In autoresponder emails.

PROFILE_CONFIRMATION - Retrieves Edit Profile autoresponder emails.

AUTOMATED - Retrieves custom autoresponder emails.

CAMPAIGN_ACTIVE - Retrieves active automated messages (including programs messages).

CAMPAIGN_COMPLETED - Retrieves completed groups of automated messages.

CAMPAIGN_CANCELLED - Retrieves canceled groups of automated messages.

CAMPAIGN_SCRAPE_TEMPLATE - Retrieves email that use content retrieval.

INCLUDE_TAGS - Returns all tags associated with the sent email.

EXCLUDE_ZERO_SENT - Excludes emails with no contacts.

MAILING_COUNT_ONLY - Returns only the count of sent emails for a specific date range.

EXCLUDE_TEST_MAILINGS - Requests to exclude test emails. If you do not provide this element, Acoustic Campaign includes all test emails.

<Envelope>
   <Body>
      <GetSentMailingsForOrg>
         <PRIVATE />
         <SENT />
         <DATE_START>07/25/201100:00:00</DATE_START>
         <DATE_END>09/30/201123:59:59</DATE_END>
      </GetSentMailingsForOrg>
   </Body>
</Envelope>

<Envelope>
  <Body>
    <RESULT>
      <SUCCESS>TRUE</SUCCESS>
      <Mailing>
        <MailingId>5758</MailingId>
        <ReportId>109118</ReportId>
        <ScheduledTS>2011-06-14 10:54:06.0</ScheduledTS>
        <MailingName>
          <![CDATA[This is the mailingname]]>
        </MailingName>
        <ListName>
          <![CDATA[This is the databasename]]>
        </ListName>
        <ListId>4615</ListId>
        <UserName> John Doe </UserName>
        <SentTS/>
        <NumSent>0</NumSent>
        <Subject>
          <![CDATA[SummerSale]]>
        </Subject>
        <Visibility>Private</Visibility>
      </Mailing>
      <Mailing>
        <MailingId>5758</MailingId>
        <ReportId>109118</ReportId>
        <ScheduledTS>2011-06-14 10:54:06.0</ScheduledTS>
        <MailingName>
          <![CDATA[MyMailing2]]>
        </MailingName>
        <ListName>
          <![CDATA[This is the databasename 2]]>
        </ListName>
        <ListId>4616</ListId>
        <UserName>John Doe</UserName>
        <SentTS/>
        <NumSent>0</NumSent>
        <Subject>
          <![CDATA[SummerSale]]>
        </Subject>
        <Visibility>Private</Visibility>
      </Mailing>
    </RESULT>
  </Body>
</Envelope>

<Envelope>
  <Body>
    <RESULT>
      <SUCCESS>TRUE</SUCCESS>
      <SentMailingsCount>5758</SentMailingsCount>
    </RESULT>
  </Body>
</Envelope>

Elements (Results)

SUCCESS - True if successful; False if not.

Mailing - XML nodes that define the instances of each email. Contains MailingId, ParentTemplateId, ReportId, ScheduledTS, MailingName, ListName, ListId, ParentListId, UserName, SentTS, NumSent, SentMailingsCount, Subject, Visibility, and Tags as children.

MailingId - Returns the email ID

ParentTemplateId - Returns the parent email ID for the email

ReportId - Returns the report ID for an instance of an automated email

ScheduledTS - Returns the scheduled date and time in the format: “mm/dd/yy hh:mm AMPM”

MailingName - Returns the email name

ListName - Returns the database name

ListId - Returns the ID of the database, query ID, or contact list that the email was sent to

ParentListId - Returns the ID of the parent database when the email was sent to a query or contact list. If the email was not sent to a query or contact list, this element is not included.

UserName - Returns the email owner’s user name

SentTS - Returns the date and time Acoustic Campaign sent the email

NumSent - Returns the number of contacts Acoustic Campaign sent a email

SentMailingsCount - Returns the number of sent emails

Subject - Returns the email subject

Visibility - Returns visibility information about the email. Values are Private or Shared

Tags - If INCLUDE_TAGS is specified in the request, returns any tags associated with the sent email

Tag - A child of Tags. The XML nodes containing the tags associated with the sent email