deliveryObject

A delivery contains the details on messages you have sent or scheduled to send, including associated content and statistics based on actions contacts took when they received the message associated with the delivery.

Name Type Description
id string The unique id assigned to the delivery.
start dateTime The date the delivery was scheduled to be sent.
messageId string The id of the message associated with the delivery.
status string The status of this delivery:
  • sent
  • sending
  • unsent
  • archived
  • skipped
  • tmp
type string The type of delivery:
  • normal - A regular email delivery sent via the application GUI.
  • test - A test delivery.
  • automated - A delivery sent via an Automator or Automated Message Rule.
  • split - A delivery made as part of an A/B split test.
  • transactional -Transactional delivery
  • triggered – API triggered delivery.
  • forwardtoafriend – Forward to a friend delivery
Note: Only the triggered,test, and transactionaltypes can be used with addDeliveries and updateDeliveries.
Note: A workflow message sent as a single send with transactional sending approval will have the transactional type. If the message does not have transactional sending approval, it will have the triggered type.
fromEmail string The email address used in the From Address for this delivery.
fromName string The name used as the From Name for the delivery
replyEmail string The email address used as the Reply-To Address for the delivery.
authentication boolean Enables sender authentication for the delivery if set to true. Sender authentication will sign your message with DomainKeys/DKIM (an authentication method that can optimize your message delivery to Hotmail, MSN, and Yahoo! email addresses). If you are associating this delivery with an automated message rule, these parameters will only be accepted if you clicked the Allow API to select sending options check box via the application UI on step 2 of creating an API triggered automated message rule.
replyTracking boolean Enables reply tracking for the delivery if set to true. Enabling Reply Tracking will store a copy of all replies to your messages on the Replies page. You may find this option convenient if you need someone other than the email address in the From line to read replies, or simply want the application to store replies. If you are associating this delivery with an automated message rule, these parameters will only be accepted if you clicked the Allow API to select sending options check box via the application UI on step 2 of creating an API triggered automated message rule.
messageRuleId string The ID of an automated message rule to associate with this delivery. Used to include this delivery in the reporting for the automator you specify.
optin boolean Whether or not the contact has opted in to receiving messages from you.
throttle long Allows you to specify a throttle rate for the delivery. Throttle rate must be in range [0, 720] (minutes). For example you could specify 60 for the throttle range.
Note: Throttling slows your email delivery speed, and thus spreads your email deliveries out over time. Many major ISPs track a sender’s reputation based on the number of unsolicited email complaints that they generate over a certain period of time. The worse your sender reputation is with ISPs, the more likely you are to have a low sender rating in the application. Spreading your email delivery over time can help mitigate the impact of this issue, help ensure optimal deliverability, and mitigate traffic spikes on your website.
fatigueOverride boolean If set to true, the delivery can be sent even if it exceeds frequency cap settings for a contact.
content messageContentObject[] Read Only

An array of the content (type, subject, content) used in the delivery.

recipients deliveryRecipientObject[] An array of the recipients who were, or are scheduled to receive the delivery. If the delivery was sent to a list, you will get back a list ID. If it was sent to a segment, you will get back a segment ID. If it was sent to an individual contact, you will get back a contact ID. If the delivery was sent to a combination of items (lists, segments, and contacts), you will get back an id for each item.
fields messageFieldObject[] An array of the API fields and data to substitute into the message being sent by this delivery.
products deliveryProductObject[] Specifies Product IDs to substitute for placeholders in product tags upon message send.Limit: 100 products
remail remailObject[] A remail object used in the delivery. Remails allow you to send another email to contacts based on actions they did not take. The goal is to persuade them to continue along the conversion process.
numSends long The number of times this delivery has been sent.
numDeliveries long The number of successful deliveries.
numHardBadEmail long The bad email address bounce type means that the email server in question has indicated that this is not a valid account.
numHardDestUnreach long The destination system unreachable bounce type means that there was a connection issue with the email server.
numHardMessageContent long The rejected due to message content hard bounce type means that the email server has identified the email as spam.
numHardBounces long The number of sent emails that were not delivered due to hard bounces.
numSoftBadEmail long The bad email address bounce type means that the email server in question has indicated that this is not a valid account.
numSoftDestUnreach long The destination system unreachable bounce type means that there was a connection issue with the email server.
numSoftMessageContent long Deferred due to message content is quite similar to the rejected message content bounce. Messages aren’t often identified this way, as ISPs don’t want you to resend something they identify as spam.
numSoftBounces long The number of sent emails that were not delivered due to soft bounces.
numOtherBounces long The number of times the delivery has bounced, where the bounces cannot be classified as hard or soft. We will try our best classify bounced deliveries as hard or soft, thus keeping them from showing up in this category.
numBounces long The total number of bounces recorded for the delivery.
uniqOpens long The number of unique opens recorded for the delivery.
numOpens long The total number of opens recorded for the delivery.
avgOpens long The number of average opens recorded for the delivery.
uniqClicks long The number of unique clicks recorded the delivery.
numClicks long The total number of clicks recorded the delivery.
avgClicks double The average number of clicks recorded the delivery.
uniqConversions long The number of unique conversions recorded for the delivery.
numConversions long The total number of conversions recorded for the delivery.
avgConversions double The number of average orders per contact recorded for the delivery.
revenue decimal The total revenue recorded for the delivery.
numSurveyResponses long The number of survey responses generated via the delivery. This applicable if the delivery in question contained a survey.
numFriendForwards long The number of times a contact receiving the delivery forward it to a friend via our forward to a friend feature.
numContactUpdates long The number of times a contact updated their information using a Manage Preferences link contained in the delivery.
numUnsubscribesByPrefs long The total number of contacts that were lost (made inactive) by unsubscribing.
numUnsubscribesByComplaint long The total number of contacts that were lost (made inactive) by complaining via an ISP feedback loop or the applications complaint system.
numContactLoss long The contact loss metric represents the total number of contacts that were marked as inactive and can no longer receive marketing emails from you as a result of this delivery.
numContactLossBounces long The total number of contacts that were made inactive because they exceeded the bounce limit you have set in your account.
deliveryRate double The delivery rate recorded for the delivery. (Delivered/Sent) * 100 = Delivery Rate
openRate double The open rate recorded for the delivery. (Opens/Delivered) * 100 = Open Rate
clickRate double The click rate recorded for the delivery. (Clicks/Opens) * 100 = Click Rate
clickThroughRate double The click through rate recorded for the delivery. (Clicks/Delivered) * 100 = Click Through Rate
conversionRate double The conversion rate recorded for the delivery. (Conversions/Clicks) * 100 = Conversion Rate
bounceRate double The bounce rate recorded for the delivery.
complaintRate double The complaint rate recorded for the delivery. (Complaints/Delivered) * 100 = Complaint Rate
contactLossRate double The contact loss rate recorded for the delivery. (Sent/Contact Loss) * 100 = Contact Loss Rate
numSocialShares long The total social shares recorded for the delivery.
sharesFacebook long The number of times the delivery was shared using Facebook.
sharesTwitter long The number of times the delivery was shared using Twitter.
sharesLinkedIn long The number of times the delivery was shared using LinkedIn.
sharesDigg long The number of times the delivery was shared using Digg.
sharesMySpace long The number of times the delivery was shared using MySpace.
numViewsFacebook long The number of times the delivery was viewed after being shared using Facebook.
numViewsTwitter long The number of times the delivery was viewed after being shared using Twitter.
numViewsLinkedIn long The number of times the delivery was viewed after being shared using LinkedIn.
numViewsDigg long The number of times the delivery was viewed after being shared using Digg.
numViewsMySpace long The number of times the delivery was viewed after being shared using MySpace.
numSocialViews long The number of times the delivery was viewed after being shared on social networks.
cartId string The ID of the shopping cart associated with the delivery.
orderId string The ID of the order associated with the delivery.
campaignId long The ID of the campaign associated with the delivery.