Email

Email double opt-in

Field	Type
eventId	string
dotdigitalAccountId	int
eventDate	string (ISO 8601)
contactId	int
contactEmail	string
contactMobileNumber	string

Email social view

Field	Type
eventId	string
dotdigitalAccountId	int
eventDate	string (ISO 8601)
contactId	int
contactEmail	string
contactMobileNumber	string
campaignId	int
campaignName	string
bookmarkName	string
ipAddress	string
type	string
campaignType	string

Email open

Field	Type
eventId	string
dotdigitalAccountId	int
eventDate	string (ISO 8601)
contactId	int
contactEmail	string
contactMobileNumber	string
campaignId	int
campaignName	string
emailType	string
ipAddress	string
userAgent	string
mailClient	string
mailClientVersion	string
isBot	bool
campaignType	string

Email click

Field	Type
eventId	string
dotdigitalAccountId	int
eventDate	string (ISO 8601)
contactId	int
contactEmail	string
contactMobileNumber	string
campaignId	int
campaignName	string
linkId	int
ipAddress	string
userAgent	string
url	string
redirectTo	string
emailType	string
productRecommendationId	int
campaignType	string

Email failed

Filterable by status: Soft bounce, hard bounce, mail block

Field	Type
eventId	string
dotdigitalAccountId	int
eventDate	string (ISO 8601)
contactId	int
contactEmail	string
contactMobileNumber	string
campaignId	int
campaignName	string
campaignType	string
status	string
subStatus	string

Email unsubscribed

Field	Type
eventId	string
dotdigitalAccountId	int
eventDate	string (ISO 8601)
status	string
contactId	int
contactEmail	string
contactMobileNumber	string
campaignId	int
campaignName	string
campaignType	string

Email ISP complaint

Field	Type
eventId	string
dotdigitalAccountId	int
eventDate	string (ISO 8601)
contactId	int
contactEmail	string
contactMobileNumber	string
campaignId	int
campaignName	string
campaignType	string

Email send

Field	Type
eventId	string
dotdigitalAccountId	int
eventDate	string (ISO 8601)
contactId	int
contactEmail	string
contactMobileNumber	string
campaignId	int
campaignName	string
splitTestVersion	string
sendId	int
subject	string
sendStatus	string
sendStatusReason	string
campaignType	string

Email reply

Access the full content of email replies and attachments through the API.

When email replies contain large amounts of content or attachments, Firehose stores this data separately as large objects (LOBs). You can download this content using the Retrieve large object endpoint.

This feature is available to anyone on our CXDP package.

Find the large object ID

The large object ID (lobId) tells the API which content to retrieve.

For email reply content:

The lobId is in the ContentReference field of the reply event.

For email reply attachments:

The lobId is in the ContentReference field of the attachment object.
Retrieve the content

Use the retrieve large object endpoint to download the content: Retrieve lob API endpoint

Field	Type
eventId	string
dotdigitalAccountId	int
eventDate	string (ISO 8601)
contactId	int
contactEmail	string
contactMobileNumber	string
campaignId	int
campaignName	string
isHtml	bool
replyType	string
fromAddress	string
subject	string
toAddress	string
forwardedAddress	string
ccAddresses	string
contentReference	string
attachmentsCount	int
attachmentsNames	string
attachmentsReferences	string
customReplyToAddress	string
campaignType	strin

Page view

Field	Type
eventId	string
dotdigitalAccountId	int
eventDate	string (ISO 8601)
contactId	int
contactEmail	string
contactMobileNumber	string
campaignId	int
campaignName	string
productRecommendationId	int
productRecommendationName	string
productRecommendationType	string
url	string
pageTitle	string
usedCookie	bool
roiMarkers	List
campaignType	string

roiMarkers

Field	Type
dataType	string
isOverridable	bool
name	string
value	string

Email campaign send

Field	Type
eventId	string
dotdigitalAccountId	int
eventDate	string (ISO 8601)
campaignId	int
sendId	int
subject	string
fromName	string
fromAddress	string
tags	list
splitTestVariant	string
links	list
name	string
sendDateAndTime	int64
emailFormat	string
customReplyAddress	string
campaignType	string
splitTest	string
sendType	boolean
listsSentTo	list
segmentsSentTo	list
preferencesSentTo	list

SMS

SMS click

Field	Type
eventId	string
dotdigitalAccountId	int
eventDate	string (ISO 8601)
contactId	int
contactEmail	string
contactMobileNumber	string
ipAddress	string
userAgent	string
fullForwardingLinkUrl	string
messageId	string
linkType	string
campaignId	int
campaignName	string
sendType	string

SMS send

Field	Type
eventId	string
dotdigitalAccountId	int
eventDate	string (ISO 8601)
contactId	int
contactEmail	string
contactMobileNumber	string
campaignId	int
campaignName	string
splitTestVariant	string
sendId	int
sendStatus	string
sendStatusReason	string
sendType	string

SMS delivered

Field	Type
eventId	string
dotdigitalAccountId	int
eventDate	string (ISO 8601)
contactId	int
contactEmail	string
contactMobileNumber	string
campaignId	int
campaignName	string
sendType	string

SMS failed

Filterable by status: failed, expired, deleted, soft bounce, hard bounce, skipped

Field	Type
eventId	string
dotdigitalAccountId	int
eventDate	string (ISO 8601)
contactId	int
contactEmail	string
contactMobileNumber	string
campaignId	int
campaignName	string
status	string
subStatus	string
sendType	string

SMS unsubscribed

Field	Type
eventId	string
dotdigitalAccountId	int
eventDate	string (ISO 8601)
contactId	int
status	string
contactEmail	string
contactMobileNumber	string
smsCampaignId	int
campaignName	string
sendType	string
listIds	List

SMS reply

Field	Type
eventId	string
dotdigitalAccountId	int
eventDate	string (ISO 8601)
receivedOn	string
messageId	string
sentTo	string
message	string
keyword	string
contactId	int
contactEmail	string
contactMobileNumber	string
campaignId	string
campaignName	string
sendType	string

Push Notification

Push notification click

Field	Type
messageId	int
programId	int
dateTimeSent	string (ISO 8601)
dateTimeClicked	string (ISO 8601)
contactId	int
eventId	string
dotdigitalAccountId	int
eventDate	string (ISO 8601)
programName	string
contactEmail	string
contactMobileNumber	string

Push notification send

Field	Type
eventId	string
dotdigitalAccountId	int
eventDate	string (ISO 8601)
contactId	int
contactEmail	string
contactMobileNumber	string
messageId	int
programId	int
dateTimeSent	string (ISO 8601)
isFailed	bool
failReason	string

Push notification error

Field	Type
eventId	string
dotdigitalAccountId	int
eventDate	string (ISO 8601)
contactId	int
contactEmail	string
contactMobileNumber	string
externalMessageId	string
system	string
message	string
deviceId	string
errorCode	int
dateTimeErrored	string (ISO 8601)

Transactional Email

Transactional email failed

Field	Type
eventId	string
dotdigitalAccountId	int
eventDate	string (ISO 8601)
status	string
subStatus	string
contactId	int
messageGuid	string
isComplaint	bool
metadata	string

Transactional email ISP complaint

Currently not available - coming soon

Transactional email click

Field	Type
eventId	string
dotdigitalAccountId	int
eventDate	string (ISO 8601)
contactId	int
messageGuid	string
ipAddress	string
userAgent	string
url	string
metadata	string

Transactional email open

Field	Type
eventId	string
dotdigitalAccountId	int
eventDate	string (ISO 8601)
contactId	int
messageGuid	string
ipAddress	string
userAgent	string
metadata	string

Transactional email campaign send

Field	Type
eventId	string
dotdigitalAccountId	int
eventDate	string (ISO 8601)
campaignId	int
messageId	string
subject	string
fromName	string
fromAddress	string
tags	List
links	List
name	string
sendDateAndTime	string
emailFormat	string
customReplyAddress	string
metadata	string

Landing Page

Landing page view

Field	Type
eventId	string
dotdigitalAccountId	int
eventDate	string (ISO 8601)
contactId	int
contactEmail	string
contactMobileNumber	string
landingPageName	string
ipAddress	string
userAgent	string