Field Name in API |
Name in Firehose JSON |
Is Default? |
Applies to Event Types |
Field description |
N/A |
event_id |
Y |
ALL |
36 character unique UUID - use this for deduplication |
datetime |
datetime |
Y |
ALL |
The datetime that the event occured at. - DEPRECATED November 20th 2017 Please use event_timestamp |
|
event_timestamp |
Y |
ALL |
The unix timestamp that the event occured at converted from the network default timezone. |
N/A |
action |
Y |
ALL |
One of "impression", "click", or "conversion" |
status |
status |
Y |
Conversion |
One of "pending", "approved", or "rejected" |
ad_id |
transaction_id |
Y |
ALL |
The transaction_id that identifies the session for a conversion |
affiliate_id |
affiliate_id |
Y |
ALL |
The id of the publisher/affiliate that drove the traffic |
affiliate_manager_id |
affiliate_manager_id |
N |
ALL |
The id of the employee assigned as the affiliate manager |
offer_id |
offer_id |
Y |
ALL |
The id of the offer that the action occurred for |
goal_id |
goal_id |
N |
ALL |
The goal id of the action, if any |
N/A |
timezone |
Y |
ALL |
The timezone for any datetime objects in the event. |
sub |
source |
N |
ALL |
The source field, set on click. |
affiliate_info1 |
aff_sub |
N |
ALL |
the aff_sub field, set on click |
affiliate_info2 |
aff_sub2 |
N |
ALL |
the aff_sub2 field, set on click |
affiliate_info3 |
aff_sub3 |
N |
ALL |
the aff_sub3 field, set on click |
affiliate_info4 |
aff_sub4 |
N |
ALL |
the aff_sub4 field, set on click |
affiliate_info5 |
aff_sub5 |
N |
ALL |
the aff_sub5 field, set on click |
access_control_decision |
access_control_decision |
Y |
ALL |
One of 0 - event is clean, 1 - event was flagged, 2 - event was blocked |
access_control_reason_code |
access_control_reason_code |
Y |
ALL |
OK = 0; BAD_IP_REPUTATION = 1; BASIC FRAUD = 2; BOT_GENERATED = 3; NON_HUMAN_SCRIPT = 4; PROXY = 5; SPOOFED = 6; |
affiliate_click_id |
affiliate_click_id |
N |
ALL |
the affiliate_click_id field, set on click. Used for Affiliate's unique session identifiers - NEW July 17th 2017 |
affiliate_unique1 |
affiliate_unique1 |
N |
ALL |
the affiliate_unique1 field, set on click. Used for unique identifiers - NEW July 17th 2017 |
affiliate_unique2 |
affiliate_unique2 |
N |
ALL |
the affiliate_unique2 field, set on click. Used for unique identifiers - NEW July 17th 2017 |
affiliate_unique3 |
affiliate_unique3 |
N |
ALL |
the affiliate_unique3 field, set on click. Used for unique identifiers - NEW July 17th 2017 |
affiliate_unique4 |
affiliate_unique4 |
N |
ALL |
the affiliate_unique4 field, set on click. Used for unique identifiers - NEW July 17th 2017 |
affiliate_unique5 |
affiliate_unique5 |
N |
ALL |
the affiliate_unique5 field, set on click. Used for unique identifiers - NEW July 17th 2017 |
fraud_reason_data |
fraud_reason_data |
N |
Conversion |
Fraud reason data passed back from Mobile SDK fraud tools on Conversion - NEW July 20th 2017 |
status_code |
status_code |
Y |
Conversion |
status code of conversion. These codes are described further in <http://help.tune.com/hasoffers/conversion-status-codes/> |
advertiser_id |
advertiser_id |
N |
ALL |
the id of the advertiser whose offer this event is for |
advertiser_manager_id |
advertiser_manager_id |
N |
ALL |
the id of the employee assigned as the manager for the advertiser whose offer this event is for |
N/A |
mobile_ad_id |
N |
n/a |
Unused |
creative_url_id |
offer_url_id |
N |
Click, Conversion |
the id of the additional offer url, if applicable |
customer_id |
customer_id |
N |
Conversion |
The id of the customer. This is only utilized for the customer list functionality in the HasOffers platform. |
revenue |
revenue |
Y |
ALL |
The revenue generated by the event. This is a float to support up to 5 decimal places. - NEW Aug 17 2016 |
revenue |
revenue_cents |
Y |
ALL |
the number of cents of revenue generated by the event. This is a float to support up to 5 decimal places - (DEPRECATED Aug 17 2016) DELETED JULY 17 2017 |
revenue_type |
revenue_type |
Y |
ALL |
The revenue type of the offer. One of "cpa_flat", "cpa_percentage", "cpa_both", "cpc", or "cpm" |
payout |
payout |
Y |
ALL |
The payout generated by the event. This is a float to support up to 5 decimal places. - NEW Aug 17 2016 |
payout |
payout_cents |
Y |
ALL |
the number of cents of payout generated by the event. This is a float to support up to 5 decimal places - (DEPRECATED Aug 17 2016) DELETED JULY 17 2017 |
payout_type |
payout_type |
Y |
ALL |
The revenue type of the offer. One of "cpa_flat", "cpa_percentage", "cpa_both", "cpc", or "cpm" |
sale_amount |
sale_amount |
N |
Conversion |
The sale amount generated by the event. This is a float to support up to 5 decimal places. |
sale_amount |
sale_cents |
N |
Conversion |
the number of cents of sale amount generated by the event. This is a float to support up to 5 decimal places - (DEPRECATED Aug 17 2016) DELETED JULY 17 2017 |
currency |
currency |
N |
ALL |
the currency of the payout, revenue, and sale amount |
url |
refer |
Y |
ALL |
the referer from the HTTP headers of the click |
N/A |
click_url |
Y |
ALL |
The url that triggered the event, for impressions this will be an impression url, for clicks it will be a tracking link, for conversions, a conversion url. |
pixel_refer |
pixel_refer |
N |
Conversion |
the referer from the HTTP headers of the conversion, if a pixel based conversion |
ip |
ip |
Y |
Conversion |
the ip address that the conversion came from. If pixel this should match the Session IP, if postback this should be the IP of the advertiser's server. |
user_agent |
user_agent |
Y |
ALL |
the user agent of the user's device, from the click |
country_code |
country_code |
Y |
ALL |
the country code where the user is located |
browser_id |
browser_id |
Y |
ALL |
The id of the browser |
N/A |
is_click_unique |
Y |
Click |
Does the user have a previous session cookie in their browser. If so 0, if not, 1. |
ad_campaign_id |
ad_campaign_id |
N |
ALL |
id of ad campaign that offer click came from |
ad_campaign_creative_id |
ad_campaign_creative_id |
N |
ALL |
creative id of ad campaign creative that caused the click |
offer_file_id |
offer_file_id |
N |
ALL |
creative file id of the offer creative that caused the click |
cdn_xfer_bytes |
offer_file_size |
N |
Impression |
size of offer file that was loaded for this click/impression |
N/A |
media_usage_fee_cents |
N |
Impression |
fee in cents for media usage. Fees are incurred for loading creatives. |
session_ip |
session_ip |
Y |
Click, Conversion |
the IP address of the user that clicked the tracking link |
session_datetime |
session_datetime |
Y |
Conversion |
the unix timestamp when the session was started (timestamp of the click) |
N/A |
is_server_response |
N |
Click |
Signifies the session data storage location. Server side if 1, client side if 0. |
N/A |
server_response_useragent |
N |
|
user agent of server response |
N/A |
offer_expires |
Y |
ALL |
Offer expiration datetime. |
N/A |
session_on_impression |
Y |
Impression, Click |
Does the session start on click (default) or on impression? Boolean value |
device_brand |
device_brand |
Y |
ALL |
brand of device detected from useragent of click |
device_model |
device_model |
Y |
ALL |
model of device detected from useragent of click |
device_os |
device_os |
Y |
ALL |
Operating System of device detected from useragent of click |
device_os_version |
device_os_version |
Y |
ALL |
Operating System version of device detected from useragent of click |
device_id |
device_id |
N |
Click, Conversion |
device_id field, set primarily on click. |
device_id_md5 |
device_id_md5 |
N |
Click, Conversion |
MD5 hash of device_id field, set primarily on click. |
device_id_sha1 |
device_id_sha1 |
N |
Click, Conversion |
SHA1 hash of device_id field, set primarily on click. |
android_id |
android_id |
N |
Click, Conversion |
android_id field |
android_id_md5 |
android_id_md5 |
N |
Click, Conversion |
MD5 hash of android_id field |
android_id_sha1 |
android_id_sha1 |
N |
Click, Conversion |
SHA1 hash of android_id field |
mac_address |
mac_address |
N |
Click, Conversion |
MAC address field |
mac_address_md5 |
mac_address_md5 |
N |
Click, Conversion |
MD5 hash of MAC address field |
mac_address_sha1 |
mac_address_sha1 |
N |
Click, Conversion |
SHA1 hash of MAC address field |
odin |
odin |
N |
Click, Conversion |
open device identifier. This is mostly deprecated. More information here: https://code.google.com/p/odinmobile/ |
ios_ifa |
ios_ifa |
N |
Click, Conversion |
IOS Identifier for advertising. This is the standard identifier for IOS devices. |
ios_ifa_md5 |
ios_ifa_md5 |
N |
Click, Conversion |
MD5 hash of IOS Identifier for advertising. This is the standard identifier for IOS devices. |
ios_ifa_sha1 |
ios_ifa_sha1 |
N |
Click, Conversion |
SHA1 hash of IOS Identifier for advertising. This is the standard identifier for IOS devices. |
ios_ifv |
ios_ifv |
N |
Click, Conversion |
IOS Identifier for vendors. Here is a quick document of when this might be used <http://help.tune.com/marketing-console/apples-ifa-vs-ifv-when-to-use-which-and-why/> |
user_id |
user_id |
N |
Click, Conversion |
User Id field. Useful when integrating with Google analytics. More Information here: https://support.google.com/analytics/answer/3123666?hl=en and here: https://developers.google.com/analytics/devguides/collection/ios/v3/user-id |
unknown_id |
unknown_id |
N |
Click, Conversion |
Available text field for non-standard identifiers |
advertiser_info |
advertiser_info |
N |
Conversion |
Advertiser-supplied information, if distinct from adv_sub |
adv_sub1 |
adv_sub |
N |
Conversion |
the adv_sub field, set on conversion |
adv_sub2 |
adv_sub2 |
N |
Conversion |
the adv_sub2 field, set on conversion |
adv_sub3 |
adv_sub3 |
N |
Conversion |
the adv_sub3 field, set on conversion |
adv_sub4 |
adv_sub4 |
N |
Conversion |
the adv_sub4 field, set on conversion |
adv_sub5 |
adv_sub5 |
N |
Conversion |
the adv_sub5 field, set on conversion |
req_connection_speed |
req_connection_speed |
Y |
Click, Conversion |
The connection speed of the session, collected on click based on the Session IP |
payout_group_id |
payout_group_id |
N |
Conversion |
The payout group that applies to this event |
revenue_group_id |
revenue_group_id |
N |
Conversion |
The revenue group that applies to this event |
google_aid |
google_aid |
N |
Click, Conversion |
The Google Advertising Identifier. This is the standard identifier for Android Devices. |
google_aid_sha1 |
google_aid_sha1 |
N |
Click, Conversion |
SHA1 hash of The Google Advertising Identifier. This is the standard identifier for Android Devices. |
google_aid_md5 |
google_aid_md5 |
N |
Click, Conversion |
MD5 hash of The Google Advertising Identifier. This is the standard identifier for Android Devices. |
windows_aid |
windows_aid |
N |
Click, Conversion |
The Windows Advertising Identifier. This is the standard identifier for Windows Mobile Devices. |
windows_aid_sha1 |
windows_aid_sha1 |
N |
Click, Conversion |
SHA1 hash of The Windows Advertising Identifier. This is the standard identifier for Windows Mobile Devices. |
windows_aid_md5 |
windows_aid_md5 |
N |
Click, Conversion |
MD5 hash of The Windows Advertising Identifier. This is the standard identifier for Windows Mobile Devices. |
mobile_carrier |
mobile_carrier |
Y |
Click, Conversion |
The mobile carrier whose network the click came from. This is detected based on the IP of the click |