conversionObject

A conversion is used track when a contact performs an action in response to an email you send them (make a purchase, download a white paper, etc.).

Name Type Comments
id string The unique id assigned to the conversion
contactId string The unique id assigned to the contact you want to associate a conversion with.
email string The email address of the conversion contact.
orderId string The order identifier. This should be unique per order and will be used to prevent duplicate orders.
item string The SKU of the line item. Certain item codes are reserved for special use: subtotal, taxes, shipping, and total.
description string The description of the line item.
quantity int The unit count of the line item.
amount decimal The line item total amount of the line item.
orderTotal int The total number of orders made
createdDate dateTime The date and time of the conversion. If no date/time is provided, then the system will time stamp the record.
deliveryId string The unique id assigned to a delivery you want to associate a conversion with.
messageId string The unique id assigned to a message you want to associate a conversion with.
automatorId string The unique id assigned to an automator you want to associate a conversion with.
listId string The unique id assigned to a list you want to associate a conversion with.
segmentId string The unique id assigned to a segment you want to associate a conversion with.
deliveryType string

If the conversion object is associated with a delivery, the type of delivery will be returned when calling readConversion. Valid values are:

  • 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.

If you are on the old order service and you try to pass a type that is not one of the 4 valid types then type will be ignored.

tid string

A unique id which associates a conversion with a specific contact and delivery. When conversion tracking is enabled in the application, you can pull the tid from the bronto tracking cookie and use it in the addConversion call to record a conversion that a specific contact makes from a specific delivery.

Note: The tid will take priority over other ids (deliveryId, contactId, email) passed in.
Note: The tid is not returned when calling readConversion. In order to obtain the tid, you must pull it from the bronto tracking cookie.