EBC
Messaging - Email BroadCast#
Occurence: A supporter has engaged with an email broadcast message.
Key Data: The level of supporter engagement with a received email, e.g open, clicks, form submissions, or unsubscribes. The data can also reveal whether a message was undelivered (due to a hard or soft bounce), as well as supporter 'feedback' about the message, e.g they clicked to report the message as 'spam'.
The supporter must have actively engaged with a received message in order for a transaction record to be output. For email the lowest engagement level recorded is 'open', which means that a tracking pixel was loaded.
Export file columns#
Account ID#
Identifies the subaccount this item belongs to
Example: 94
Supporter ID#
The unique numerical database identifier for a supporter.
Example: 212200
Default: 0
Supporter Email#
The primary email address of a supporter, which will typically be used as the basis for identifying a unique supporter to which any transactions will be associated.
<= 500 characters
Example: otto.nv@example.com
Date Created#
The date a supporter was created. [ISO 8601 format date]
Example: 2024-12-01
Date Modified#
The date a supporter was last modified. [ISO 8601 format date]
Example: 2024-12-01
Campaign Number#
A unique send identifier referring to a broadcast.
Example: 1536
Campaign Type#
EBC
The Campaign Type is used to determine the layout of the data columns in the output stream.
Campaign ID#
A reference name for used for the email broadcast campaign.
Example: A TEST broadcast
<= 100 characters
Campaign Date#
The recorded date [YYYY-MM-DD] of this transaction. If left blank during transactional import, the service will apply the import date. The reference timezone for this service is US/Eastern.
Example: 2024-12-01
Campaign Time#
The recorded time [HH:MM:SS] of this transaction. The reference timezone for this service is US/Eastern.
Example: 13:53:02
Default: 00:00:00
Campaign Status#
'R' indicates a log record.
Allowed values:
R
Default: R
Campaign Data 1#
open
If present, the flag indicates that a supporter opened the message.
Campaign Data 2#
click
If present, the flag indicates that the supporter clicked in a tracked link in the message.
Campaign Data 3#
formsub
If present, the flag indicates that the supporter submitted a form.
Campaign Data 4#
hbounce
If present, the flag indicates a hard bounce from the email system.
Campaign Data 5#
sbounce
If present, the flag indicates a soft bounce from the email system.
Campaign Data 6#
unsub
Flag to indicate a supporter unsubscribe action from this broadcast
Campaign Data 7#
fbloop
The supporter marked the message as 'spam' or 'junk'
Campaign Data 8#
No output for this transaction type.
Campaign Data 9#
A unique identifier referring to the broadcast message that was sent to a supporter. As a single broadcast may contain multiple messages, this identifier can be used to point to the specific message.
Example: 1536
Campaign Data 10#
No output for this transaction type.
Campaign Data 11#
No output for this transaction type.
Campaign Data 12#
No output for this transaction type.
Campaign Data 13#
No output for this transaction type.
Campaign Data 14#
No output for this transaction type.
Campaign Data 15#
No output for this transaction type.
Campaign Data 16#
No output for this transaction type.
Campaign Data 17#
No output for this transaction type.
Campaign Data 18#
No output for this transaction type.
Campaign Data 19#
No output for this transaction type.
Campaign Data 20#
No output for this transaction type.
Campaign Data 21#
No output for this transaction type.
Campaign Data 22#
No output for this transaction type.
Campaign Data 23#
No output for this transaction type.
Campaign Data 24#
No output for this transaction type.
Campaign Data 25#
No output for this transaction type.
Campaign Data 26#
No output for this transaction type.
Campaign Data 27#
No output for this transaction type.
Campaign Data 28#
No output for this transaction type.
Campaign Data 29#
No output for this transaction type.
Campaign Data 30#
No output for this transaction type.
Campaign Data 31#
No output for this transaction type.
Campaign Data 32#
Details about the user agent used when submitting the content. The string consists of key/value pairs that are separated by a ~ (tilde) character.
mobile: N or Y depending on whether the user agent identifies as a mobile device. tablet: N or Y depending on whether the user agent identifies as a type of device classed as a 'tablet'. device: The manufacturer of the type of device used by the user agent. os: The underlying operating system of a user agent. browser: The type of web-browser that was used.
Example: mobile:N~tablet:N~device:APPLE~os:Mac OS X~browser:Firefox 11
Campaign Data 33#
No output for this transaction type.
Campaign Data 34#
No output for this transaction type.
Campaign Data 35#
No output for this transaction type.
External Reference 1#
When used outside of API page processing, this field may be populated using the URL parameters utm_source or by the generic parameter en_txn1. Content will be automatically truncated if the maximum length is exceeded, and the last three characters replaced by '...' to indicate that a string has been truncated.
<= 100 characters
External Reference 2#
When used outside of API page processing, this field may be populated using the URL parameters utm_medium or by the generic parameter en_txn2. Content will be automatically truncated if the maximum length is exceeded, and the last three characters replaced by '...' to indicate that a string has been truncated.
<= 100 characters
External Reference 3#
When used outside of API page processing, this field may be populated using the URL parameters utm_campaign or by the generic parameter en_txn3. Note: Content will be automatically truncated if the maximum length is exceeded, and the last three characters replaced by '...' to indicate that a string has been truncated.
<= 100 characters
External Reference 4#
When used outside of API page processing, this field may be populated using the URL parameters utm_content or by the generic parameter en_txn4. Note: Content will be automatically truncated if the maximum length is exceeded, and the last three characters replaced by '...' to indicate that a string has been truncated.
<= 100 characters
External Reference 5#
When used outside of API page processing, this field may be populated using the URL parameters utm_term or by the generic parameter en_txn5. Note: Content will be automatically truncated if the maximum length is exceeded, and the last three characters replaced by '...' to indicate that a string has been truncated.
<= 100 characters
External Reference 6#
When used outside of API page processing, this field may also be populated by a user-defined page property [Page > Admin > Campaign References], or by the url query parameter en_txn6. When added as a page parameter, the field is referred to as Campaign Reference 1 in the dashboard settings.
If a value is presented in both places, the url query parameter will take precedence. Note: Content will be automatically truncated if the maximum length is exceeded, and the last three characters replaced by '...' to indicate that a string has been truncated.
<= 100 characters
External Reference 7#
When used outside of API page processing, this field may also be populated by a user-defined page property [Page > Admin > Campaign References], or by the url query parameter en_txn7. When added as a page parameter, the field is referred to as Campaign Reference 2 in the dashboard settings. If a value is presented in both places, the url query parameter will take precedence. Note: Content will be automatically truncated if the maximum length is exceeded, and the last three characters replaced by '...' to indicate that a string has been truncated.
<= 100 characters
External Reference 8#
When used outside of API page processing, this field may also be populated by a user-defined page property [Page > Admin > Campaign References], or by the url query parameter en_txn8. When added as a page parameter, the field is referred to as Campaign Reference 3 in the dashboard settings. If a value is presented in both places, the url query parameter will take precedence. Note: Content will be automatically truncated if the maximum length is exceeded, and the last three characters replaced by '...' to indicate that a string has been truncated.
<= 100 characters
External Reference 9#
When used outside of API page processing, this field may also be populated by a user-defined page property [Page > Admin > Campaign References], or by the url query parameter en_txn9. When added as a page parameter, the field is referred to as Campaign Reference 4 in the dashboard settings. If a value is presented in both places, the url query parameter will take precedence. Note: Content will be automatically truncated if the maximum length is exceeded, and the last three characters replaced by '...' to indicate that a string has been truncated.
<= 100 characters
External Reference 10#
When used outside of API page processing, this field may also be populated by a user-defined page property [Page > Admin > Campaign References], or by the url query parameter en_txn10. When added as a page parameter, the field is referred to as Campaign Reference 5 in the dashboard settings. If a value is presented in both places, the url query parameter will take precedence. Note: Content will be automatically truncated if the maximum length is exceeded, and the last three characters replaced by '...' to indicate that a string has been truncated.
<= 100 characters
Email Address#
The primary email address of a supporter, which will typically be used as the basis for identifying a unique supporter to which any transactions will be associated.
<= 500 characters
Example: otto.nv@example.com
Title#
A supporter's title to be used in salutations
<= 50 characters
Example: Dr
First Name#
A supporter's first name
<= 500 characters
Example: Otto
Middle Name#
A supporter's middle name
<= 500 characters
Example: Niemand
Last Name#
A supporter's last name
<= 500 characters
Example: Normalverbraucher
Address 1#
The first line of the supporter's address
<= 1000 characters
Address 2#
The second line of the supporter's address
<= 1000 characters
Address 3#
The third line of the supporter's address
<= 1000 characters
City#
The city in a supporter's address
<= 500 characters
Example: Musterstadt
Region#
The supporter's region, state, county, province or similar
<= 500 characters
Example: Musterregion
Country#
The supporter's country
<= 500 characters
Example: DE
Phone Number#
The primary phone number for a supporter
<= 200 characters
Example: +49 4066969123