Push API Data Structure - iOS

Introduction

The push API supports in-app events data in addition to installation data, both for organic and non-organic installs. It also sends re-targeting campaigns data, showing re-attributions and re-engagements.

Supported Fields - iOS

Push API for iOS contains the following fields: 

Field Non-Organic Install FB Install TW Install Organic Install Non-Organic In-App FB In-App TW In-App Organic In-App
attributed_touch_type Y Y Y N Y Y Y N
attributed_touch_time Y Y Y N Y Y Y N
event_type Y Y Y Y Y Y Y Y
attribution_type
(Organic or Regular)
Y Y Y Y Y Y Y Y
click_time Y Y Y Y Y Y Y Y
download_time Y Y Y Y Y Y Y Y
install_time Y Y Y Y Y Y Y Y
media_source Y Y Y Y Y Y Y Y
agency Y Y Y Y Y Y Y Y
af_channel Y Y Y N Y Y Y N
af_keywords Y Y Y N Y Y Y N
campaign Y Y Y Y Y Y Y Y
af_c_id Y Y Y N Y Y Y N
af_adset Y Y Y N Y Y Y N
af_adset_id Y Y Y N Y Y Y N
af_ad Y Y Y N Y Y Y N
af_ad_id Y Y Y N Y Y Y N
fb_campaign_name Y Y Y Y Y Y Y Y
fb_campaign_id Y Y Y Y Y Y Y Y
fb_adset_name Y Y Y Y Y Y Y Y
fb_adset_id Y Y Y Y Y Y Y Y
fb_adgroup_name Y Y Y Y Y Y Y Y
fb_adgroup_id Y Y Y Y Y Y Y Y
af_ad_type Y Y Y N Y Y Y N
af_siteid Y Y Y Y Y Y Y Y
af_sub1 Y Y Y Y Y Y Y Y
af_sub2 Y Y Y Y Y Y Y Y
af_sub3 Y Y Y Y Y Y Y Y
af_sub4 Y Y Y Y Y Y Y Y
af_sub5 Y Y Y Y Y Y Y Y
http_referrer Y Y Y Y Y Y Y Y
click_url Y Y Y Y Y Y Y Y
af_cost_model Y N N N Y Y Y N
af_cost_value Y N N N Y Y Y N
af_cost_currency Y N N N Y Y Y N
cost_per_install Y N N Y Y Y Y Y
is_retargeting Y Y Y Y Y Y Y Y
re_targeting_conversion_type Y Y Y Y Y Y Y Y
country_code Y Y Y Y Y Y Y Y
city Y Y Y Y Y Y Y Y
ip Y Y Y Y Y Y Y Y
wifi Y Y Y Y Y Y Y Y
mac Y Y Y Y Y Y Y Y
language Y Y Y Y Y Y Y Y
appsflyer_device_id Y Y Y Y Y Y Y Y
idfa Y Y Y Y Y Y Y Y
customer_user_id Y Y Y Y Y Y Y Y
idfv Y Y Y Y Y Y Y Y
platform Y Y Y Y Y Y Y Y
device_type Y Y Y Y Y Y Y Y
device_name Y Y Y Y Y Y Y Y
os_version Y Y Y Y Y Y Y Y
app_version Y Y Y Y Y Y Y Y
sdk_version Y Y Y Y Y Y Y Y
app_id Y Y Y Y Y Y Y Y
app_name Y Y Y Y Y Y Y Y
bundle_id Y Y Y Y Y Y Y Y
event_time Y Y Y Y Y Y Y Y
event_name Y Y Y Y Y Y Y Y
event_value Y Y Y Y Y Y Y Y
currency Y Y Y Y Y Y Y Y
download_time_selected_timezone Y Y Y Y Y Y Y Y
click_time_selected_timezone Y Y Y Y Y Y Y Y
install_time_selected_timezone Y Y Y Y Y Y Y Y
event_time_selected_timezone Y Y Y Y Y Y Y Y
selected_currency Y Y Y Y Y Y Y Y
revenue_in_selected_currency N N N N Y Y Y Y
cost_in_selected_currency Y Y Y Y N N N N

 

Push API iOS Specific Parameters

Some Push API parameters are called differently than on the V5 reports. There are also several parameters that exist on Push API, but not on other V5 sources. You can find them in the table below.

Push API Field Name V5 Field Name Description
fb_campaign_name N/A Facebook campaign name*
fb_campaign_id N/A Facebook campaign ID number*
fb_adset_name N/A Facebook ad set name*
fb_adset_id N/A Facebook ad set ID number*
fb_adgroup_name N/A Facebook ad group name*
fb_adgroup_id N/A Facebook ad group ID*
event_type N/A install/in-app-event
attribution_type N/A Organic or Regular(non-organic)
click_time attributed touch time Attributed touch time
download_time N/A Timestamp of the download click on the app store,  as appears on the device (UTC timezone)
agency  af_prt Name of the attributed agency 
cost_per_install af_cost_value Cost in original currency
re_targeting_conversion_type retargeting_conversion_type Re-engagement / Re-attribution
appsflyer_device_id appsflyer_id Unique app installation identifier per device 
currency N/A USD
selected_currency N/A Currency specified in the event or for the app in the dashboard
revenue_in_selected_currency N/A Revenue in the currency selected for the app in the dashboard
cost_in_selected_currency N/A Cost in the currency selected for the app in the dashboard
download_time_selected_timezone N/A Time of download in the time zone selected for the app
click_time_selected_timezone N/A Time of the ad click in the time zone selected for the app
install_time_selected_timezone N/A Time of the first app launch in the time zone selected for the app
event_time_selected_timezone N/A Time of the event occurrence in the time zone selected for the app
device_name N/A Name of the device as entered by the user

* All the "Facebook" parameters, such as fb_campaign_name, fb_campaign_id or fb_adgroup_id, only get values when the user is attributed to Facebook.

Push API iOS Examples

Below you can find examples of Push API messages sent on various iOS related scenarios for your reference.

iOS Organic Install

fb_campaign_id:
mac:
attributed_touch_time:
fb_adgroup_name:
os_version: 10.3.1
agency:
ip: 192.40.59.42
media_source: Organic
http_referrer:
fb_adgroup_id:
download_time_selected_timezone: 2017-06-25 11:08:48.000+0000
app_name: Great App
af_sub3:
af_sub1:
click_url:
install_time_selected_timezone: 2017-06-25 11:14:51.495+0000
af_sub5:
download_time: 2017-06-25 11:08:48
cost_per_install:
click_time:
attributed_touch_type:
install_time: 2017-06-25 11:14:51
attribution_type: organic
fb_adset_name:
cost_in_selected_currency:
af_sub4:
event_type: install
event_value:
app_version: 5.9
sdk_version: v4.4.7.3
fb_adset_id:
af_keywords:
device_name: iPhoneSA
re_targeting_conversion_type:
bundle_id: com.great.app
event_time_selected_timezone: 2017-06-25 11:14:51.495+0000
language: en-SA
event_name:
is_retargeting: false
appsflyer_device_id: 149839972****-*******
customer_user_id: A1636287-AFDD-4BE5-920A-************
idfa: 20534267-AB93-435A-AA6F-************
idfv: 25EFAD38-1BB0-4C69-BCC4-************
af_sub2:
wifi: true
campaign:
af_siteid:
click_time_selected_timezone:
fb_campaign_name:
platform: ios
country_code: US
city: Los Angeles
event_time: 2017-06-25 11:14:51
app_id: id123456789
selected_currency: USD
currency:
device_type: iPhone5,2

iOS Non-Organic Install

fb_campaign_id:
mac:
download_time: 2017-06-25 11:14:56
fb_adgroup_name:
fb_campaign_name:
agency:
ip: 211.36.159.244
media_source: Naver
http_referrer: https://...
fb_adgroup_id:
download_time_selected_timezone: 2017-06-25 11:14:56.000+0000
af_ad:
af_c_id:
app_name: Great App
af_sub3:
af_sub1: textbox1
click_url: http://greatapp.onelink.me/1640755593?af_dp=greatapp%3A%2F%2Fhome&af_click_lookback=1d&pid=Naver&c=Brand_Banner&af_siteid=166571&site_id=1630071&tag=123456789&af_sub1=textbox1
click_time_selected_timezone: 2017-06-25 11:14:42.498+0000
af_sub4:
af_sub5:
city: Gajwa 1(Il)-Dong
customer_user_id: 2DB34202-3570-4AFE-845F-************
attributed_touch_time: 2017-06-25 11:14:42
cost_per_install:
campaign: Brand_Banner
language: ko-KR
attributed_touch_type: click
install_time: 2017-06-25 11:15:27
attribution_type: regular
fb_adset_name:
device_name: Administrator iPhone
cost_in_selected_currency:
install_time_selected_timezone: 2017-06-25 11:15:27.924+0000
event_type: install
event_value:
app_version: 5.9
sdk_version: v4.4.7.3
af_ad_id:
af_keywords:
af_adset:
re_targeting_conversion_type:
idfv: BC519A10-0BB4-453E-8CAF-************
event_time_selected_timezone: 2017-06-25 11:15:27.924+0000
af_ad_type:
event_time: 2017-06-25 11:15:27
is_retargeting: false
appsflyer_device_id: 1498421696638-*******
af_cost_value:
idfa: 86CF431C-DAD1-4830-8FB4-************
af_sub2:
af_cost_currency:
wifi: false
event_name:
bundle_id: com.great.app
af_siteid: 1630071
af_cost_model:
os_version: 10.3.2
platform: ios
af_channel:
country_code: KR
fb_adset_id:
click_time: 2017-06-25 11:14:42
af_adset_id:
app_id: id123456789
selected_currency: USD
currency:
device_type: iPhone8,1

iOS In-App Event - Non-Organic

fb_campaign_id:
fb_adgroup_name:
attributed_touch_time: 2016-11-17 13:54:27
mac:
fb_campaign_name:
agency:
platform: ios
media_source: goodsource_int
http_referrer:
fb_adgroup_id:
download_time_selected_timezone: 2016-11-17 13:55:00.000+0000
af_ad:
af_c_id:
app_name: Great App
af_sub3: 040c6072-7a9d-4b1b-a420-************
af_sub1: EXP-ID-0
click_url: http://greatapp.onelink.me/1640755593?pid=goodsource_int&c=WhiteBanner&af_dp=greatapp%3A%2F%2Fhome&checkOut=2016-11-19&site_id=1419876&tag=&af_siteid=1419876&af_sub1=EXP-ID-0&af_sub2=EXP-RUN-ID-0&af_sub3=040c6072-7a9d-4b1b-a420-************
click_time_selected_timezone: 2016-11-17 13:54:27.369+0000
install_time_selected_timezone: 2016-11-17 13:56:00.206+0000
af_sub5:
af_ad_id:
af_cost_value:
download_time: 2016-11-17 13:55:00
cost_per_install:
campaign: WhiteBanner
language: en-TH
attributed_touch_type: click
install_time: 2016-11-17 13:56:00
attribution_type: regular
fb_adset_name:
device_name: iPhone
event_time: 2017-06-25 11:07:29
af_sub4:
appsflyer_device_id: 147941611****-*******
af_cost_currency:
app_version: 5.8
sdk_version: v4.4.7.3
fb_adset_id:
af_keywords:
event_value: {"af_content_type":"Location","af_date_a":"26-06-2017","af_customer_user_id":"ADF19EF4-292B-4AE9-A575- ************","af_language_id":"1", "af_content_id":"0","af_currency":"THB"}
af_adset:
re_targeting_conversion_type:
idfv: 7DA81473-B358-43B5-BE7D-************
event_time_selected_timezone: 2017-06-25 11:07:29.353+0000
ip: 182.232.209.50
revenue_in_selected_currency:
event_name: af_search
is_retargeting: false
customer_user_id: ADF19EF4-292B-4AE9-A575-************
af_ad_type:
idfa: AA4621BB-9338-4DD7-9B41-************
af_sub2: EXP-RUN-ID-0
wifi: false
bundle_id: com.great.app
af_siteid: 1419876
af_cost_model:
os_version: 10.3.2
af_channel:
country_code: TH
city: Bangkok
click_time: 2016-11-17 13:54:27
af_adset_id:
app_id: id123456789
selected_currency: USD
currency: THB
event_type: in-app-event
device_type: iPhone8,1

iOS Retargeting In-App Event - Facebook Re-Engagement

fb_campaign_id: 6066670673018
fb_adgroup_name: |Auto Feed|AB:A-OriginalR|T:DAT-iOS|O:All|L:EN-US|A:BF|R:1 Day|
idfa: 956F7651-B556-47E7-8F87-************
download_time: 2016-08-29 05:13:00
mac:
fb_campaign_name: |Auto Feed|T:DAT|L:EN-US|
agency:
ip: 103.199.42.245
media_source: Facebook Ads
fb_adgroup_id: 6066670699018
download_time_selected_timezone: 2016-08-29 05:13:00.000+0000
af_ad:
app_name: Great App
af_sub3:
af_sub1:
click_url:
click_time_selected_timezone:
install_time_selected_timezone: 2017-06-13 02:16:09.102+0000
af_sub5:
af_ad_id:
af_cost_value:
attributed_touch_time: 2017-06-13 02:16:07
cost_per_install:
click_time: 2017-06-13 02:16:07
language: en-VN
attributed_touch_type: click
install_time: 2017-06-13 02:16:09
attribution_type: regular
fb_adset_name: |Auto Feed|AB:A-OriginalR|T:DAT-iOS|O:All|L:EN-US|A:BF|R:1 Day|
device_name: Thanh scb
event_time: 2017-06-25 11:20:00
af_sub4:
appsflyer_device_id: 147247283****-*******
af_cost_currency:
app_version: 4.6
sdk_version: v4.4.5.1
fb_adset_id: 6066670689818
af_keywords:
af_adset:
re_targeting_conversion_type: re-engagement
idfv: C1B85E8B-25F2-4181-9745-************
event_time_selected_timezone: 2017-06-25 11:20:00.407+0000
revenue_in_selected_currency:
event_name: af_search
is_retargeting: true
customer_user_id: F3F21FD3-83B2-4B74-9927-************
af_ad_type:
event_value: {"af_content_type":"City","af_date_a":"01-07-2017","af_customer_user_id":"F3F21FD3-83B2-4B74-9927-************","af_language_id":"1","af_date_b":"02-07-2017","af_logged_in":"1", "af_content_id":"17190","af_currency":"VND"}
af_sub2:
af_channel: Facebook
wifi: false
bundle_id: com.great.app
campaign: |Auto Feed|T:DAT|L:EN-US|
af_siteid:
af_cost_model:
os_version: 10.3.2
platform: ios
country_code: VN
city: Duong Tran Van Can
af_c_id:
af_adset_id:
app_id: id123456789
selected_currency: USD
currency: VND
event_type: in-app-event
device_type: iPhone 7

 

Was this article helpful?
0 out of 1 found this helpful