Data field dictionary V5.0 (raw data specification)

At a glance: The data field dictionary contains the fields found in raw data reports.

Raw data is a premium feature and is delivered using:

  • CSV file download Go to Reports > Export Data.
  • Pull API
  • Data locker: Deposit the files in your data locker
  • Push API: Attribution raw data in real-time 

Additional information about raw data can be found at:

Date fields in CSV files: Date fields in the CSV files have the format yyyy-mm-dd. When you open a CSV file in Excel, date fields are formatted using your computer's date and time settings. Be sure to select the appropriate date display in Excel.

Data field dictionary 

The dictionary columns are: 

  • API Name: field name used by Push API
  • Display Name: field name found in reports (CSV, Data Locker, Pull API, etc) 
  • Source: the original source location of the field content as follows:
  • Description
    • Some fields have different meanings depending on the context of the event. Meaning as a result of a UA or retargeting campaign.
  • Context: Where a field is available in specific reports/or has a slightly different meaning depending on the report context then this is indicated here as follows:
    • Retargeting: These fields, have a specific meaning in the context of a retargeting campaign.
    • Data Locker: Available only in Data Locker.
    • Protect360: Available only in Protect360 reports
    • Fields added after December 2019, the date the field is added
  • Field type and length:
    • String: The maximum length of the string.  We don't usually enforce field length limitations on receipt of the data but the data may be truncated thereafter. Don't exceed the field length specification.
    • Date Time: 
      • For all reports except Push API: String with format, yyyy-mm-dd hh:mm:ss.  For example, 2019-09-17 00:09:25
      • Note: When opening CSV files using Excel, the field displays using the default regional settings. You can change the display format in Excel. To see the unformatted value, open the file using an editor.
      • Push API:
        • For timestamp fields in UTC: format yyyy-mm-dd hh:mm:ss.sssFor example, 2019-09-17 00:09:25.123 
        • For timestamp fields in selected time zone: format yyyy-mm-dd hh:mm:ss.±th:tm. For example 2019-01-20 04:51:16.000+0000
    • Enum n char: Enum fields can only contain specific values. For example, Cost currency has 3 characters and can contain only currency codes as specified
    • Enum 5 char boolean: The value of the field can be either TRUE or FALSE
Data field dictionary V5.0 (raw data specification)

API parameter Name

Field name

Source

Description

Context

Field type

af_ad

Ad

Link

Facebook info is also included

 

String 100

af_ad_id

Ad ID

Link

Facebook info is also included

 

String 24

af_ad_type

Ad Type

Link

Type of ad (banner, footer etc.)

 

String 24

af_adset

Adset

Link

Facebook info is also included

 

String 100

af_adset_id

Adset ID

Link

 

 

String 24

af_c_id

Campaign ID

Link

Campaign   String 24

af_channel

Channel

Link

Channel of the media source, Example: YouTube for Google, Instagram for Facebook   Dynamic Enum String 20

af_cost_currency*

Cost Currency

Link

Cost currency (list)   Enum 3 char

af_cost_model

Cost Model

Link

CPC/CPI/CPM/Other. Currently, all cost is calculated according to CPI regardless of this value

 

String 20

af_cost_value

Cost Value

Link

Cost in original currency. Supports up to 4 digits after the decimal point. Example: 320.5095   String 20

af_keywords

Keywords

Link

Received from the integration partner

 

String 100

af_attribution_lookback

Attribution Lookback Link

UA: Lookback window for click attribution. The window duration is the maximum CTIT (click time to install) for the new user to be attributed to the source displaying the ad/link. Note: The equivalent parameter in the attribution link is af_click_lookback.

Retargeting: Retargeting click-through lookback

 Retargeting

 

 

3 char max

af_prt

Partner

Link

Agency or PMD

 

String 50

af_reengagement
_window

Reengagement Window

Link

The re-engagement attribution window is the time period during which an event can be attributed to a retargeting campaign

Limitation: The field is not populated in retargeting campaigns.

Retargeting 3 char max

af_siteid

Site ID

Link

Publisher ID   String 24

af_sub_siteid

Sub Site ID

Link

Sub-publisher ID

 

String 50

af_sub1

Sub Param 1

Link

Optional custom parameter defined by the advertiser   String 100

af_sub2

Sub Param 2

Link

Optional custom parameter defined by the advertiser   String 100

af_sub3

Sub Param 3

Link

Optional custom parameter defined by the advertiser   String 100

af_sub4

Sub Param 4

Link

Optional custom parameter defined by the advertiser   String 100

af_sub5

Sub Param 5

Link

Optional custom parameter defined by the advertiser   String 100

campaign

Campaign

Link

Campaign name for special integrations (example Facebook) returns via API and not via link.

 

String 100

is_retargeting

Is Retargeting

Link

UA: FALSE

Retargeting: TRUE for retargeting conversions and events

Retargeting

Enum 5 char boolean

media_source

Media Source

Link

Regular networks (excluding Facebook) will appear on the link.

 

String 50

original_url

Original URL

Link

UA: Click/impression URL used

Retargeting: contains one of the following: Retargeting link, deep linking data, empty for SRNs.

Retargeting String 2083 (URL)

user_agent

User Agent

Link

The user agent for the URL   String 200

advertising_id

Advertising ID

SDK

The advertising ID is a user-resettable, unique, anonymous ID for advertising provided by Google Play seroadvices.   String 40

android_id

Android ID

SDK

Android device ID (GAID)   String 20

amazon_aid

Amazon Fire ID

SDK

Amazon Fire TV advertising ID

 

String 40

app_id App ID

SDK

ID of the app
  • iOS: id123456789
  • Android: com.appsflyer.referrersender
 

iOS: String 12

Android: String 100

app_name

App Name

SDK

Name of the app   String 100

app_version

App Version

SDK

App version   8 char max

appsflyer_id

AppsFlyer ID

SDK

UA: unique installation identifier. A unique ID generated by AppsFlyer when the app launches for the first time. The ID is unique per app per installation. This means that a new ID is allocated if the app is deleted and then installed again. See also Customer User ID.

Retargeting:
re-attribution: a new ID is allocated, re-engagement: ID remains unchanged 

Retargeting

iOS: String 24

Android: String 33

bundle_id

Bundle ID

SDK

Identification to match either a single app or a group of apps (for iOS)   String 100

carrier

Carrier

SDK

Carrier name   String 50

country_code

Country Code

SDK

Country Code. Example: GB, US   Enum String 2

custom_data

Custom Data

SDK

  • Data that is sent using the SDK
  • SeeAndroid and iOS
  String 1024

customer_user_id

Customer User ID

SDK

Set by the app owner, using the SDK, for use as a unique user identifier.    String 100
deeplink_url

Deeplink URL

SDK

The path for an internal activity in the app that users are deep linked into. Use this for deep linking and deferred deep linking.

Available from Jan 2020

String1024

device_category

Device Category

SDK

  • Possible values include: phone, tablet,other
  • Compatible with Android SDK V4.8.8 and later
  String 20

device_type

Device Type

SDK

The commercial model name of the device.Example: SM-GM284 or iPhone7

 

String 100

device_download_time

Device Download Time

SDK

App download completion time using the device's clock

Available in Data Locker from Oct 2019. Available in general from Jan 2020.   Date Time

event_name

Event Name

SDK

Name of the event that took place   String 100

event_revenue

Event Revenue

SDK

Amount of revenue using Event Revenue Currency.   String 20

event_revenue_

currency*

Event Revenue Currency

SDK

The event revenue currency as reported to the SDK.   String 20

event_time

Event Time

SDK

UA: time the event happened

Retargeting: will be the same as the install time

Retargeting Date Time

event_value

Event Value

SDK

Value of the event

Note: Don't send more than 1000 characters from the SDK as depending on report type we may truncate these. 

  String 1000

idfa

IDFA

SDK

iOS: Advertiser ID   40 char max

idfv

IDFV

SDK

App level identifier for a particular vendor   40 char max

imei

IMEI

SDK

Device IMEI for Android and iOS   14 char max

install_app_store

Install App Store

SDK

Identifies the Android store where the app was downloaded from (details)   String 50

install_time

Install Time

SDK

UA: Time of the first launch after installation.

Retargeting: The first app launch after re-engagement/re-attribution

Retargeting

Date Time

ip

IP

SDK

IP address   String 15 for IP V4

is_lat

Is Lat

SDK

Limit ad tracking (LAT): When true, the user has enabled LAT on their device and no advertiser ID is available to AppsFlyer.  Starting Jan 2020 Enum 5 char boolean

language

Language

SDK

Device language   String 20

oaid

OAID

SDK

Android: Advertiser ID available in some devices as an alternative or in addition to Android ID.   Starting Jan 2020 40 char max

operator

Operator

SDK

Operator name   String 50

os_version

OS Version

SDK

Operating system version   String 8

platform

Platform

SDK

Possible values: iOS, Android, or Windows Mobile

 

Enum string 8

sdk_version

SDK Version

SDK

SDK version   String 8

wifi

WIFI

SDK

TRUE/FALSE

 

Enum 5 char boolean

gp_broadcast_

referrer

GP Broadcast Referrer

SDK

  • Google Play Broadcast Referrer
  • Inorganic installs the Play
 

String 100

store_reinstall

Store Reinstall

SDK

ioS: Apple App Store, using the Apple user ID determines if this is:

  • False: new user
  • True: reinstall by an existing user
Starting from Jan 2020 Enum 5 char boolean

amazon_aid

Amazon Fire ID

 SDK

Amazon advertising ID

  String 100

city

City

AF

The most granular location of the user based on the device IP. Usually, the value holds a city name, but it can also be districts, boroughs, etc., which are more accurate.

 

String 100

attributed_touch_

time

Attributed Touch Time

AF

UA: time of the touch we attributed to.

Retargeting: retargeting engagement time

Retargeting

Date Time

attributed_touch_

type

Attributed Touch Type

AF

UA:The type of touch attributed by AppsFlyer. Possible values: click/impression/TV/pre-installed

Re-engagement: click, impression (re-attribution only)

Retargeting

Enum 10 char max

contributor_1_

af_prt

Contributor 1 Partner

AF

Agency or PMD: always converted to lowercase

 

String 50

contributor_1_

campaign

Contributor 1 Campaign

AF

Campaign of the contributor   String 100

contributor_1_

match_type

Contributor 1 Match Type

AF

Possible values include:

gp_referrer, id_matching, srn

  String 50

contributor_1_

media_source

Contributor 1 Media Source

AF

Media Source of the contributor   String 50

contributor_1_

touch_time

Contributor 1 Touch Time

AF

Time of the touch

 

Date Time

contributor_1_

touch_type

Contributor 1 Touch Type

AF

Type of the touch

click, impression, TV

 

Enum 10 char max

contributor_2_af_prt

Contributor 2 Partner

AF

Agency or PMD   String 50

contributor_2_

campaign

Contributor 2 Campaign

AF

Campaign of the contributor   String 100

contributor_2_

match_type

Contributor 2 Match Type

AF

Possible values include:

gp_referrer/id_matching/srn

  String 50

contributor_2_

media_source

Contributor 2 Media Source

AF

Media Source of the contributor   String 50

contributor_2_

touch_time

Contributor 2 Touch Time

AF

Time of the touch   Date Time

contributor_2_

touch_type

Contributor 2 Touch Type

AF

Type of the touch

(could be click/impression/TV)

 

Enum 10 char max

contributor_3_af_prt

Contributor 3 Partner

AF

Agency or PMD   String 50

contributor_3_

campaign

Contributor 3 Campaign

AF

Campaign of the contributor   String 100

contributor_3_

match_type

Contributor 3 Match Type

AF

Possible values include:

gp_referrer/id_matching/srn

  String 50

contributor_3_

media_source

Contributor 3 Media Source

AF

Media source of the contributor   String 50

contributor_3_

touch_time

Contributor 3 Touch Time

AF

Time of the touch   Date Time

contributor_3_

touch_type

Contributor 3 Touch Type

AF

Type of the touch

(could be click / impression / TV)

 

Enum 10 char max

dma

DMA

AF

Designated Market Area - regions are the geographic areas in the US where local television viewing is measured by the Nielsen company.   String 10

event_revenue_usd

Event Revenue USD

AF

The amount of revenue in USD or in preferred currency, configurable under App Settings.   String 20

event_source

Event source

AF

The source of the event - either SDK or S2S   Enum 3 char max

http_referrer

HTTP Referrer

AF

Identifies the address of the webpage that linked to the AppsFlyer click URL. By checking the referrer, you can see where the request originated   String 2083 char max

is_primary_attribution

Is Primary Attribution

AF

UA: True

Retargeting: During a re-engagement window, we attribute to both the original media source (prior to the re-engagement) and to the re-engagement media source. While the event is within the re-engagement window. The original media source will be FALSE (not primary attribution). The re-engagement media source will be TRUE.

Retargeting

Enum 5 char max

is_receipt_validated

Is Receipt Validated

AF

TRUE/FALSE/NULL when implemented in the SDK, empty otherwise

 

Enum 5 char max

match_type

Match Type

AF

Attribution method type. Possible values include:

gp_referrer (Google Play referrer string)

id_matching

fingerprinting

srn (Self-Reporting Network)

tv (TV attribution)

preinstall

  String 50

postal_code

Postal code

AF

Based on IP of the SDK   String - 10 char max

region

Region

AF

Based on IP from the SDK

 

String 100

retargeting_

conversion_type

Retargeting Conversion Type

AF

UA: N/A

Re-targeting: Re-engagement, Re-attribution

Retargeting

 

Enum 14 char max

state

State

AF

Based on IP from the SDK

 

String 100

keyword_id

Keyword ID

AF

     

keyword_match_type

Keywords Match Type

AF

The keyword match type returns by search networks APIs or attribution links shall be mapped to the raw report.

Note: Google AdWords and Apple Search Ads are the only networks that return this parameter for search campaigns.

  String 100

network_account_id

Network Account ID

AF

Advertiser's account ID with the partner

 

String 100

rejected_reason_

value

Rejected Reason

AF

In targeting validation rules reports: Ruleset ID that caused the rejection

Targeting validation

String 100

rejected_reason Rejected Reason AF In targeting validation rules reports - the type of rule that caused the rejection. Example, e.g.install-validation-rule Targeting validation String 100
blocked_reason Blocked Reason AF In Protect360 the reason the install is blocked. Example: install_hijacking, bots  Protect360  String 100
blocked_sub_reason Blocked Sub Reason AF

In Protect 360 particular sub reason for a blocked install. Example: Reason: install_hijacking. Sub-reason: referer hijack, CTCT_anomalies

Protect360  String 100

blocked_reason_

value

Blocked Reason Value AF Additional information regarding the block. Example: Site ID. Protect360  String 100

blocked_reason_

rule

Blocked Reason Rule AF This field will be deprecated. Until so the value is always null.    To be deprecated

gp_click_time

Google Play Click Time

Google Play field

Time of app page load in Google Play after an ad click.

Time source: Google API

Available from Android SDK version 4.8.5

Use case example: By comparinginstall_time to gp_click time you can gain an insite as to how long it takes users from the time they begin to download the app until they open the app.

  Timestamp

gp_install_begin

Google Play Install Begin Time

Google Play field

Time that installation begins
Time source: User device. Meaning the time that displays on the device.

Note:

Available from Android SDK version 4.8.5

  Timestamp

gp_referrer

Google Play Referrer

Google Play field

The referrer URL of the installed package.

Available from Android SDK version 4.8.5

  String 1024

gp_broadcast_referrer

GP Broadcast Referrer

Google Play field

Google Play Broadcast Referrer

  String 1024

Currency codes.

Was this article helpful?