Overview

📘
Branch & TUNE Export Functionality
Custom exports are available for both Branch data points and TUNE data points. Please make sure to view the correct tab - Branch or TUNE - when referencing the below documentation.

The Branch Custom Exports find and queue log records that match your search criteria for export. You can do so either via the Custom Exports section in your Branch dashboard or via the API.

Custom exports endpoints are limited to a maximum of 2 million records each and only 60 days of data can be queried at a time. Also, you can only query up to 120 days prior to the date of export via the Branch Dashboard, this does not apply to the API.

If more records are required, please make multiple requests with smaller time intervals to pull the necessary data in "batches". In some cases, Branch can increase the number of records above 2 million. Please contact Support to request an increase.

🚧
Data Changes Post iOS 14.5
Apple requires users to opt into sharing their device data through Apple's AppTrackingTransparency framework. When an install is attributed to paid ads, a 2nd install event will fire post user opt-in
Opt-ins will affect your final install count. Our recommendation is to use a different identifier (ex. IDFV) to de-dupe install events on your internal systems.
For additional information on changes post iOS 14.5, visit our FAQ Pages

🚧
Exporting from Test Environments is not supported
At this moment, it is not possible to export data out of a Branch Test environment

Authentication

Calls to the Custom Export API require an access token parameter to be passed with each request. Access tokens are generated on a per-user basis and are permanent.

Learn how to retrieve your Access Token (a.k.a. an API Key)

Rate Limits

Rate limits depend on the endpoint you are making a request to.

For creating exports, the rate limit is 10 requests per minute and 25 requests per hour.

For checking the status of an export, the rate limit is 50 requests per minute and 1000 per hour.

You will get the following reponse once you've hit the rate limit:

{
    "errors": [
        {
            "message": "Limit is exceeded for org-525983469347282987, retry after 3418 seconds",
            "error_code": 7
        }
    ]
}

🚧
Repeated requests within 60 minutes will be cached
If you make identical requests within 60 minutes of each other, you will not see multiple export jobs running. Instead, the same export job will be used. If you are using the API, the same job_id will be returned. This is to avoid the case of hundreds or thousands of requests being made for the exact same data set, within seconds or minutes of each other.
After 60 minutes, your request will kick off a new job to retrieve data.

Export Access

In order to access Custom Exports, a user will need to have both Sensitive Data and Export access.

For more details on how to give a user the required access, please read Default Access Levels, Users Roles & Permissions.

Third Party Access

Any user with access to an account’s API keys will be able to access Branch’s Custom Export API (and thus unfiltered, log-level data). As a result, we would recommend against providing third parties with the permissions required to view API keys during the invitation process.

Providing Agencies API Access

If you work with an agency that runs your advertising campaigns and want to give them access to export the subsequent data, you can provide them with access to the Custom Export API.

To provide an agency team member with access to the Custom Export API:

In the left-hand navigation, under Setup & Testing, click on Account Settings.
On the Account Settings page, click on the Agencies tab.
Expand the agency in question, find the agency team member you want to give access to, hover on the button in the Actions column and click Edit.
In the Edit Agency Team Member modal:
1. Under Access Level, check the Export box.
2. Under Permissions, check the Sensitive Data box.
Optional: add data filters
1. Under Data Filters, toggle any necessary data filters on/blue. Exported data will be filtered accordingly.
Click Save.

🚧
Agency-Tagged Data
If you do not enable the Only Show Agency-Tagged Data data filter, the Agency Team Member will be able to export sensitive data associated with all of your campaigns, regardless if they are associated with them or not.

Available Topics to Export

Please refer to the full list of available topics for Branch and TUNE.

Available Fields

Please refer to the full list of available fields for Branch and TUNE.

Accessing via Branch Dashboard

📘
We have limited the UI to exporting data for 60 days or less. In general, we recommend exporting data for a day at a time.

Rather than accessing the Custom Export API directly, you can use the Custom Exports section in your Branch dashboard to request the appropriate data via CSVs.

To request an export:

In the left-hand navigation, under the Setup & Testing section, click Data Import & Export, then click on Exports.
On the Custom Exports page, provide the following:
- The appropriate Date Range.
- The Topic type the export should include.
- The Columns of fields you want included.
- Any additional Filters you want included.
- The Download Type for the export.

You can also view any requested export in the Custom Exports Created table which includes:

Date Created
Topic / Date Range
Row Count
Format
Status

Accessing via API

Endpoint Definitions

POST /v2/logs?organization_id=ORG_ID
POST /v2/logs?app_id=APP_ID
Headers:
Access-Token: API_KEY
Content-Type: application/json
Body: JSON parameters
Host: api2.branch.io

GET /v2/logs/JOB_ID
Headers:
Access-Token: API_KEY
Host: api2.branch.io

POST /v3/logs/advertisers/ADVERTISER_ID/exports/
Host: api.mobileapptracking.com/

GET /v3/logs/advertisers/ADVERTISER_ID/exports/JOB_ID
Host: api.mobileapptracking.com/

Building the Export Request

Find and queue all records that match search criteria for export; returns a “handle” to be used in the download export request.

advertiser_id \| String Your TUNE Advertiser ID;REQUIRED. FOR TUNE CALLS ONLY
app_id \| String Your Branch App ID; REQUIRED FOR BRANCH CALLS ONLY
organization_id \| String Your Branch Organization ID; optional FOR BRANCH CALLS ONLY
api_key / access token \| String Your API Key / Access Token; REQUIRED
report_type \| String The Branch EO topic to be exported; REQUIRED
start_date \| Date The beginning datetime for the requested results, provided in ISO-8601 format including Hours, Minutes, Seconds and Milliseconds. ; REQUIRED Dates without offsets (i.e. a timezone) default to the value provided for the timezone parameter. If the timezone parameter is not specified, the dates timezone defaults to UTC. Date must be within the last 120 days. Example: 2016-01-01T00:00:00Z
end_date \| Date The end datetime for the requested results, provided in ISO-8601 format including Hours, Minutes, Seconds and Milliseconds. ; REQUIRED Dates without offsets (i.e. a timezone) default to the value provided for the timezone parameter. If the timezone parameter is not specified, the dates timezone defaults to UTC. Example: 2016-01-01T23:59:59:999Z
timezone \| Timezone Timezone for results. Accepts tz database strings like ‘America/Los_Angeles’. Optional parameter; results are returned in the dashboard timezone if not provided. Will default to UTC only if dashboard timezone is not set
filter \| Filter BRANCH CALLS ONLY; Filter by fields and boolean operators against fields of the LogInstalls model; must be URI encoded and JSON parsed. Example: ["gt","last_attributed_touch_timestamp", 1604015756]
filter_cthulhu \| Filter TUNE CALLS ONLY; Filter by fields and boolean operators against fields of the LogInstalls model; must be URI encoded and JSON parsed. See the Appendix for the Cthulhu Filter Specification. Example: `&filter_cthulhu=%5B%22and%22%2C%5B%22eq%22%2C%22mat_id%22%2C%223bc15517-92d5-4b7f-9837-e9a30d6fb9b8%22%5D%2C%5B%22eq%22%2C%22site_event_id%22%2C1844998705%5D%5D`
fields \| Comma Separated List List of comma-separated fields desired in results. REQUIRED
limit \| Integer Limit the number of items returned per request. Maximum allowed value is 2 million. If more than 2 million records are required, please make multiple requests with smaller time intervals to pull the data needed in “batches”; REQUIRED
response_format \| Nullable String Format of the response; can be either "json" or "csv". If not selected, defaults to CSV. Branch uses UTF-8 encoding for CSV files.

advertiser_id | String

Your TUNE Advertiser ID;REQUIRED.

FOR TUNE CALLS ONLY

app_id | String

Your Branch App ID; REQUIRED

FOR BRANCH CALLS ONLY

organization_id | String

Your Branch Organization ID; optional

FOR BRANCH CALLS ONLY

api_key / access token | String

Your API Key / Access Token; REQUIRED

report_type | String

The Branch EO topic to be exported; REQUIRED

start_date | Date

The beginning datetime for the requested results, provided in ISO-8601 format including Hours, Minutes, Seconds and Milliseconds. ; REQUIRED

Dates without offsets (i.e. a timezone) default to the value provided for the timezone parameter. If the timezone parameter is not specified, the dates timezone defaults to UTC. Date must be within the last 120 days. Example: 2016-01-01T00:00:00Z

end_date | Date

The end datetime for the requested results, provided in ISO-8601 format including Hours, Minutes, Seconds and Milliseconds. ; REQUIRED

timezone | Timezone

Timezone for results. Accepts tz database strings like ‘America/Los_Angeles’.

Optional parameter; results are returned in the dashboard timezone if not provided. Will default to UTC only if dashboard timezone is not set

filter | Filter

BRANCH CALLS ONLY; Filter by fields and boolean operators against fields of the LogInstalls model; must be URI encoded and JSON parsed. Example: ["gt","last_attributed_touch_timestamp", 1604015756]

filter_cthulhu | Filter

TUNE CALLS ONLY; Filter by fields and boolean operators against fields of the LogInstalls model; must be URI encoded and JSON parsed. See the Appendix for the Cthulhu Filter Specification. Example: &filter_cthulhu=%5B%22and%22%2C%5B%22eq%22%2C%22mat_id%22%2C%223bc15517-92d5-4b7f-9837-e9a30d6fb9b8%22%5D%2C%5B%22eq%22%2C%22site_event_id%22%2C1844998705%5D%5D

fields | Comma Separated List

List of comma-separated fields desired in results. REQUIRED

limit | Integer

Limit the number of items returned per request. Maximum allowed value is 2 million. If more than 2 million records are required, please make multiple requests with smaller time intervals to pull the data needed in “batches”; REQUIRED

response_format | Nullable String

Format of the response; can be either "json" or "csv". If not selected, defaults to CSV. Branch uses UTF-8 encoding for CSV files.

Sample Export Request

curl -X POST 'https://api2.branch.io/v2/logs?app_id=123456700098765432'
    -H "Content-Type: application/json"
    -H "Access-Token: YOUR_ACCESS_TOKEN_HERE"
    -d '{"report_type": "eo_open",
            "limit": 100,
            "fields": ["timestamp","name"],
            "start_date": "2019-12-09T00:00:00Z",
            "end_date": "2019-12-09T01:59:59Z",
            "filter": ["gt","last_attributed_touch_timestamp", 1604015756]
            }'

https://api.mobileapptracking.com/v3/logs/advertisers/ADVERTISER_ID/exports/installs?api_key=YOUR_ACCESS_TOKEN_HERE&start_date=2019-01-14T00:00:00&end_date=2019-01-15T00:00:00&timezone=UTC&fields=site.name,site.id,device_ip&limit=100&response_format=csv

Sample Export Response

{"handle":"1612dbb3-85ef-49f8-b1c5-5818c163600c","export_job_status_url":"https://api2.branch.io/v2/logs/1612dbb3-85ef-49f8-b1c5-5818c163600c?app_id=123456700098765432"}

{"handle":"0818e641-cd5c-4498-8a17-77152689bb94","export_job_status_url":"http://api.mobileapptracking.com/v3/logs/advertisers/ADVERTISER_ID/exports/0818e641-cd5c-4498-8a17-77152689bb94?api_key=YOUR_ACCESS_TOKEN_HERE","branch_url":"http://tlnk.branch.io/v3/logs/advertisers/ADVERTISER_ID/exports/installs?start_date=2019-01-14T00%3A00%3A00%2B00%3A00&end_date=2019-01-15T00%3A00%3A00%2B00%3A00&fields=site.name%2Csite.id%2Cdevice_ip&filter_cthulhu=%5B%22in%22%2C%20%22advertiser_id%22%2C%20ADVERTISER_ID%5D&response_format=csv&timezone=UTC&limit=100&api_key=YOUR_ACCESS_TOKEN_HERE"}

Building the Download Export Request

Finds and exports requested queue (by handle) and provides URL location for download.

advertiser_id \| String Your TUNE Advertiser ID; REQUIRED ONLY FOR TUNE CALLS
api_key / access token \| String Your API Key / Access Token; REQUIRED
handle \| String The ID returned by the log export queue. REQUIRED

advertiser_id | String

Your TUNE Advertiser ID; REQUIRED ONLY FOR TUNE CALLS

api_key / access token | String

Your API Key / Access Token; REQUIRED

handle | String

The ID returned by the log export queue. REQUIRED

Sample Download Export Request

curl -X GET https://api2.branch.io/v2/logs/<YOUR_HANDLE>\?app_id\=<YOUR_BRANCH_APP_ID>
  -H "Content-Type: application/json" 
  -H "Access-Token:<YOUR_ACCESS_TOKEN>"

http://api.mobileapptracking.com/v3/logs/advertisers/ADVERTISER_ID/exports/0818e641-cd5c-4498-8a17-77152689bb94?api_key=YOUR_ACCESS_TOKEN_HERE

Sample Download Export Response

{"code":200,"lines_exported":2000000,"status":"complete","response_url":"https://branch-exports-web.s3.amazonaws.com/732662944269095814-eo_open-2019-12-10-2019-12-10-1612dbb3-85ef-49f8-b1c5-5818c163600c-bUlN2lwyTE10qIVH.csv?Signature=YOUR_ACCESS_TOKEN_HERE&AWSAccessKeyId=YOUR_ACCESS_TOKEN_HERE&Expires=1577305615"}

{"report_schedule_id": null, "lines_exported": null, "context": "", "url": "https://branch-exports-web.s3.amazonaws.com/ADVERTISER_ID-installs-2019-01-14-2019-01-15-0818e641-cd5c-4498-8a17-77152689bb94-wxGQxyHo0Djw2ktt.csv?Signature=5XN9MRMftyQ1XafNSTW4STMpT9U%3D&AWSAccessKeyId=AKIAI7A6NRHGMRDK2LIQ&Expires=1548295211", "percent_complete": 100, "status": "complete", "branch_url": "http://tlnk.branch.io/v3/logs/advertisers/ADVERTISER_ID/exports/0818e641-cd5c-4498-8a17-77152689bb94?api_key=YOUR_ACCESS_TOKEN_HERE"}

Appendix

Branch Available Topics

Topic	Human Readable Name
`eo_click_blocked`	Blocked Clicks
`eo_commerce_event_blocked`	Blocked Commerce Events
`eo_content_event_blocked`	Blocked Content Events
`eo_branch_cta_view_blocked`	Blocked CTA Views
`eo_custom_event_blocked`	Blocked Custom Events
`eo_impression_blocked`	Blocked Impressions
`eo_install_blocked`	Blocked Installs
`eo_open_blocked`	Blocked Opens
`eo_pageview_blocked`	Blocked Pageviews
`eo_reinstall_blocked`	Blocked Reinstalls
`eo_sms_sent_blocked`	Blocked SMS Sent
`eo_user_lifecycle_event_blocked`	Blocked User Lifecycle Events
`eo_web_session_start_blocked`	Blocked Web Session Starts
`eo_click`	Clicks
`eo_commerce_event`	Commerce Events
`eo_content_event`	Content Events
`eo_branch_cta_view`	CTA Views
`eo_custom_event`	Custom Events
`eo_impression`	Impressions
`eo_install`	Installs
`eo_open`	Opens
`eo_pageview`	Pageviews
`webhook2`	Postback Records
`eo_reinstall`	Reinstalls
`skadnetwork_invalid_messages`	SKAdNetwork Invalid Messages
`skadnetwork_valid_messages`	SKAdNetwork Valid Messages
`eo_sms_sent`	SMS Sent
`eo_user_lifecycle_event`	User Lifecycle Events
`eo_web_session_start`	Web Session Starts
`eo_web_to_app_auto_redirect`	Web To App Auto Redirects

🚧
Blocked Topics
Branch allows the export of blocked topics for up to 60 days from the time of the request.

TUNE Available Topics

Clicks
Event Items
Events
Impressions
Installs
Opens

Branch Available EO Fields

Branch Available Fields
app_id \| Long App ID (capitalize ID in Liveview)
app_name \| String App Name
attributed \| Boolean Attributed
content_items \| ArrayStruct Content Items
custom_data \| MapStringString Custom Data
customer_event_alias \| String Customer Event Alias
days_from_last_attributed_touch_to_event \| Integer Days From Last Attributed Touch To Event
deep_linked \| `Boolean` Deep Linked
di_match_click_token \| Long DI Match Click Token
event_data_ad_type \| enum { BANNER, INTERSTITIAL, REWARDED_VIDEO, NATIVE } Ad Type
event_data_affiliation \| String Affiliation
event_data_coupon \| String Coupon
event_data_currency \| String Currency
event_data_description \| String Event Description
event_data_exchange_rate \| Double Exchange Rate
event_data_revenue \| Double Revenue
event_data_revenue_in_usd \| Double Revenue In USD
event_data_search_query \| String Search Query
event_data_shipping \| `Double` Shipping
event_data_tax \| Double Tax
event_data_transaction_id \| String Transaction ID
event_timestamp \| Long Event Timestamp
existing_user \| Boolean Existing User
external_intent_uri \| String External Intent URI
first_event_for_user \| Boolean First Event For User
hash_version \| String Hash Version
hours_from_last_attributed_touch_to_event \| Integer House From Last Attributed Touch To Event
id \| String ID
install_activity_attributed \| Boolean Install Attributed
install_activity_data_has_clicked_ad \| Boolean Install Has Clicked Ad
install_activity_data_has_clicked_email \| Boolean Install Has Clicked Email
install_activity_timestamp \| Long Install Timestamp
install_activity_touch_data_additional_data_tilde_ad_id \| Long Install Ad ID
install_activity_touch_data_additional_data_tilde_ad_set_id \| Long Install Ad Set ID
install_activity_touch_data_additional_data_tilde_campaign_id \| Long Install Campaign ID
install_activity_touch_data_additional_data_tilde_creative_id \| Long Install Creative ID
install_activity_touch_data_dollar_3p \| String Install Partner 3p Value
install_activity_touch_data_plus_via_features \| String Install Features
install_activity_touch_data_plus_web_format \| String Install Web Format
install_activity_touch_data_tilde_ad_name \| String Install Ad Name
install_activity_touch_data_tilde_ad_set_name \| String Install Ad Set Name
install_activity_touch_data_tilde_advertising_partner_id \| Long Install Ad Partner ID
install_activity_touch_data_tilde_advertising_partner_name \| String Install Ad Partner
install_activity_touch_data_tilde_agency \| String Install Agency
install_activity_touch_data_tilde_agency_id \| Long Install Agency ID
install_activity_touch_data_tilde_campaign \| String Install Campaign
install_activity_touch_data_tilde_channel \| String Install Channel
install_activity_touch_data_tilde_creative_name \| String Install Creative Name
install_activity_touch_data_tilde_customer_ad_name \| String Install Customer Ad Name
install_activity_touch_data_tilde_customer_ad_set_name \| String Install Customer Ad Set Name
install_activity_touch_data_tilde_customer_campaign \| String Install Customer Campaign
install_activity_touch_data_tilde_customer_keyword \| String Install Customer Keyword
install_activity_touch_data_tilde_customer_placement \| String Install Customer Placement
install_activity_touch_data_tilde_customer_secondary_publisher \| String Install Customer Secondary Publisher
install_activity_touch_data_tilde_customer_sub_site_name \| String Install Customer Sub Site Name
install_activity_touch_data_tilde_feature \| String Install Feature
install_activity_touch_data_tilde_journey_name \| String Install Journey Name
install_activity_touch_data_tilde_keyword \| String Install Keyword
install_activity_touch_data_tilde_placement \| String Install Placement
install_activity_touch_data_tilde_secondary_publisher \| String Install Secondary Publisher
install_activity_touch_data_tilde_stage \| String Install Stage
install_activity_touch_data_tilde_tags \| String Install Tags
install_activity_touch_data_tilde_view_name \| String Install View Name
install_activity_touch_type \| String Install Touch Type
last_attributed_touch_data_custom_fields \| String Last Attributed Touch Custom Fields
last_attributed_touch_data_dollar_3p \| String Ad Partner (3p)
last_attributed_touch_data_plus_current_feature \| String Current Feature
last_attributed_touch_data_tilde_id \| Long Last Attributed Touch ID
last_attributed_touch_data_plus_touch_id \| String Last Attributed Touch Touch ID
last_cta_view_data_plus_touch_id \| String Last CTA View Touch ID
last_attributed_touch_data_plus_via_features \| ArrayString Via Features
last_attributed_touch_data_plus_web_format \| String Web Format
last_attributed_touch_data_tilde_ad_id \| String Ad ID
last_attributed_touch_data_tilde_ad_name \| String Ad Name
last_attributed_touch_data_tilde_ad_set_id \| String Ad Set ID
last_attributed_touch_data_tilde_ad_set_name \| String Ad Set Name
last_attributed_touch_data_tilde_advertising_account_name \| String Advertising Account Name
last_attributed_touch_data_tilde_advertising_account_id \| String Advertising Account ID
last_attributed_touch_data_tilde_advertising_partner_id \| String Ad Partner ID
last_attributed_touch_data_tilde_advertising_partner_name \| String Ad Partner
last_attributed_touch_data_tilde_agency \| String Agency
last_attributed_touch_data_tilde_agency_id \| String Agency ID
last_attributed_touch_data_tilde_banner_dimensions \| String Banner Dimensions
last_attributed_touch_data_tilde_branch_ad_format \| String Branch Ad Format
last_attributed_touch_data_tilde_campaign \| String Campaign
last_attributed_touch_data_tilde_campaign_id \| String Campaign ID
last_attributed_touch_data_tilde_campaign_type \| String Campaign Type
last_attributed_touch_data_tilde_channel \| String Channel
last_attributed_touch_data_tilde_creative_name \| String Creative Name
last_attributed_touch_data_tilde_creative_id \| String Creative ID
last_attributed_touch_data_tilde_customer_ad_name \| String Customer Ad Name
last_attributed_touch_data_tilde_customer_ad_set_name \| String Customer Ad Set Name
last_attributed_touch_data_tilde_customer_campaign \| String Customer Campaign
last_attributed_touch_data_tilde_customer_keyword \| String Customer Keyword
last_attributed_touch_data_tilde_customer_placement \| String Customer Placement
last_attributed_touch_data_tilde_customer_secondary_publisher \| String Customer Secondary Publisher
last_attributed_touch_data_tilde_customer_sub_site_name \| String Customer Sub Site Name
last_attributed_touch_data_tilde_external_touch_id \| String External Touch ID
last_attributed_touch_data_tilde_feature \| String Feature
last_attributed_touch_data_tilde_journey_id \| String Journey ID
last_attributed_touch_data_tilde_journey_name \| String Journey Name
last_attributed_touch_data_tilde_keyword \| String Keyword
last_attributed_touch_data_tilde_keyword_id \| String Keyword ID
last_attributed_touch_data_tilde_optimization_model \| String Optimization Model
last_attributed_touch_data_tilde_placement \| String Placement
last_attributed_touch_data_tilde_placement_id \| String Placement ID
last_attributed_touch_data_tilde_secondary_ad_format \| String Secondary Ad Format
last_attributed_touch_data_tilde_secondary_publisher \| String Secondary Publisher
last_attributed_touch_data_tilde_secondary_publisher_id \| String Secondary Publisher ID
last_attributed_touch_data_tilde_stage \| String Stage
last_attributed_touch_data_tilde_sub_site_name \| String Sub Site Name
last_attributed_touch_data_tilde_tags \| ArrayString Tags
last_attributed_touch_data_tilde_technology_partner \| String Technology Partner
last_attributed_touch_data_tilde_touch_subtype \| String Google Video Ads "Engaged View"
last_attributed_touch_data_tilde_tune_publisher_id \| Long TUNE Publisher ID
last_attributed_touch_data_tilde_tune_publisher_name \| String TUNE Publisher Name
last_attributed_touch_data_tilde_view_id \| String View ID
last_attributed_touch_data_tilde_view_name \| String View Name
last_attributed_touch_timestamp \| Long Last Attributed Touch Timestamp
last_attributed_touch_timestamp_iso \| String Last Attributed Touch Timestamp (ISO)
last_attributed_touch_type \| String Last Attributed Touch Type
last_cta_view_data_custom_fields \| String Last CTA View Custom Fields
last_cta_view_data_dollar_3p \| String Last CTA View Ad Partner (3p)
last_attributed_touch_data_plus_referring_domain \| String Referring Domain
last_cta_view_data_plus_via_features \| ArrayString Last CTA View Via Features
last_cta_view_data_plus_web_format \| String Last CTA View Web Format
last_cta_view_data_tilde_ad_id \| String Last CTA View Ad ID
last_cta_view_data_tilde_ad_name \| String Last CTA View Ad Name
last_cta_view_data_tilde_ad_set_id \| String Last CTA View Ad Set ID
last_cta_view_data_tilde_ad_set_name \| String Last CTA View Ad Set Name
last_cta_view_data_tilde_advertising_partner_name \| String Last CTA View Ad Partner
last_cta_view_data_tilde_agency \| String Last CTA View Agency
last_cta_view_data_tilde_banner_dimensions \| String Last CTA View Banner Dimensions
last_cta_view_data_tilde_branch_ad_format \| String Last CTA View Branch Ad Format
last_cta_view_data_tilde_campaign \| String Last CTA View Campaign
last_cta_view_data_tilde_campaign_id \| String Last CTA View Campaign ID
last_cta_view_data_tilde_campaign_type \| String Last CTA View Campaign Type
last_cta_view_data_tilde_channel \| String Last CTA View Channel
last_cta_view_data_tilde_creative_id \| String Last CTA View Creative ID
last_cta_view_data_tilde_creative_name \| String Last CTA View Creative Name
last_cta_view_data_tilde_external_touch_id \| Long Last CTA View External Touch ID
last_cta_view_data_tilde_feature \| String Last CTA View Feature
last_cta_view_data_tilde_id \| Long Last CTA View ID
last_cta_view_data_tilde_keyword_id \| String Last CTA View Keyword ID
last_cta_view_data_tilde_optimization_model \| String Last CTA View Optimization Model
last_cta_view_data_tilde_placement \| String Last CTA View Placement
last_cta_view_data_tilde_secondary_ad_format \| String Last CTA View Secondary Ad Format
last_cta_view_data_tilde_secondary_publisher \| String Last CTA View Secondary Publisher
last_cta_view_data_tilde_stage \| String Last CTA View Stage
last_cta_view_data_tilde_tags \| ArrayString Last CTA View Tags
last_cta_view_data_tilde_technology_partner \| String Last CTA View Technology Partner
last_cta_view_timestamp \| Long Last CTA View Timestamp
last_cta_view_timestamp_iso \| String Last CTA View Timestamp (ISO)
minutes_from_last_attributed_touch_to_event \| Integer Minutes From Last Attributed Touch To Event
name \| String Name of event based on selected topic
organization_id \| Long Organization ID
organization_name \| String Organization Name
origin \| String Origin
reengagement_activity_attributed \| Boolean Reengagement Activity Attributed
reengagement_activity_data_has_clicked_ad \| Boolean Reengagement Has Clicked Ad
reengagement_activity_data_has_clicked_email \| Boolean Reengagement Has Clicked Email
reengagement_activity_timestamp \| String Reengagement Timestamp
reengagement_activity_touch_data_additional_data_tilde_ad_id \| Long Reengagement Ad ID
reengagement_activity_touch_data_additional_data_tilde_ad_set_id \| Long Reengagement Ad Set ID
reengagement_activity_touch_data_additional_data_tilde_campaign_id \| Long Reengagement Campaign ID
reengagement_activity_touch_data_additional_data_tilde_creative_id \| Long Reengagement Creative ID
reengagement_activity_touch_data_dollar_3p \| String Reengagement Partner 3p Value
reengagement_activity_touch_data_plus_via_features \| String Reengagement Features
reengagement_activity_touch_data_plus_web_format \| String Reengagement Web Format
reengagement_activity_touch_data_tilde_ad_name \| String Reengagement Ad Name
reengagement_activity_touch_data_tilde_ad_set_name \| String Reengagement Ad Set Name
reengagement_activity_touch_data_tilde_advertising_partner_id \| Long Reengagement Advertising Partner ID
reengagement_activity_touch_data_tilde_advertising_partner_name \| String Reengagement Advertising Partner Name
reengagement_activity_touch_data_tilde_agency \| String Reengagement Agency
reengagement_activity_touch_data_tilde_agency_id \| Long Reengagement Agency ID
reengagement_activity_touch_data_tilde_campaign \| String Reengagement Campaign
reengagement_activity_touch_data_tilde_channel \| String Reengagement Channel
reengagement_activity_touch_data_tilde_creative_name \| String Reengagement Creative Name
reengagement_activity_touch_data_tilde_customer_ad_name \| String Reengagement Customer Ad Name
reengagement_activity_touch_data_tilde_customer_ad_set_name \| String Reengagement Customer Ad Set Name
reengagement_activity_touch_data_tilde_customer_campaign \| String Reengagement Customer Campaign
reengagement_activity_touch_data_tilde_customer_keyword \| String Reengagement Customer Keyword
reengagement_activity_touch_data_tilde_customer_placement \| String Reengagement Customer Placement
reengagement_activity_touch_data_tilde_customer_secondary_publisher \| String Reengagement Customer Secondary Publisher
reengagement_activity_touch_data_tilde_customer_sub_site_name \| String Reengagement Customer Sub Site
reengagement_activity_touch_data_tilde_feature \| String Reengagement Feature
reengagement_activity_touch_data_tilde_journey_name \| String Reengagement Journey Name
reengagement_activity_touch_data_tilde_keyword \| String Reengagement Keyword
reengagement_activity_touch_data_tilde_placement \| String Reengagement Placement
reengagement_activity_touch_data_tilde_secondary_publisher \| String Reengagement Secondary Publisher
reengagement_activity_touch_data_tilde_stage \| String Reengagement Stage
reengagement_activity_touch_data_tilde_tags \| String Reengagement Tags
reengagement_activity_touch_data_tilde_view_name \| String Reengagement View Name
reengagement_activity_touch_type \| String Reengagement Touch Type
referrer_click_timestamp \| Long Referrer Click Timestamp
seconds_from_install_to_event \| Integer Seconds From Install To Event
seconds_from_last_attributed_touch_to_event \| Integer Seconds From Last Attributed Touch To Event
seconds_from_last_attributed_touch_to_store_install_begin \| Integer Seconds From Touch To Store Install Begin
site_event_items_count \| Integer Content Items Count
store_install_begin_timestamp \| Long Store Install Begin Timestamp
timestamp \| Long Timestamp
timestamp_iso \| String Timestamp (ISO)
tune_site_event_id \| Long TUNE Site Event ID
tune_site_id \| Long TUNE Site ID
tune_site_name \| String TUNE Site Name
user_data_aaid \| String AAID
user_data_android_id \| String Android ID
user_data_app_package_name \| String App Package Name
user_data_app_version \| String App Version
user_data_brand \| String Brand
user_data_browser \| String Browser
user_data_build \| String Build
user_data_cpu_type \| String CPU Type
user_data_cross_platform_id \| String Cross Platform ID
user_data_developer_identity \| String Developer Identity
user_data_device_type \| String Device Type
user_data_environment \| String Environment
user_data_geo_city_code \| Integer City Code
user_data_geo_city_en \| Integer City
user_data_geo_country_code \| String Country Code
user_data_geo_country_en \| String Country
user_data_geo_dma_code \| Integer DMA Code
user_data_geo_lat \| Float Latitude
user_data_geo_lon \| Float Longitude
user_data_geo_postal_code \| String Postal Code
user_data_geo_region_en \| String Region
user_data_geo_region_code \| String Region Code
user_data_http_referrer \| String HTTP Referrer
user_data_idfa \| String IDFA
user_data_idfv \| String IDFV
user_data_installer_package_name \| String installer Package Name
user_data_internet_connection_type \| String Internet Connection Type
user_data_ip \| String IP Address
user_data_is_jailbroken \| Boolean IIs Jailbroken
user_data_kindle_id \| String Kindle ID
user_data_language \| String Language
user_data_limit_ad_tracking \| Boolean Limit Ad Tracking
user_data_model \| String Model
user_data_os \| String OS
user_data_os_version \| String OS Version
user_data_os_version_android \| String OS Version (Android)
user_data_past_cross_platform_ids \| ArrayString Past Cross Platforms IDs
user_data_platform \| ArrayString Platform
user_data_prob_cross_platform_ids \| ArrayStruct Probabilistic Cross Platform IDs
user_data_roku_rida \| String Roku Device ID
user_data_screen_height \| Integer Screen Height
user_data_screen_width \| Integer Screen Width
user_data_sdk_version \| String SDK Version
user_data_tune_mat_id \| String TUNE MAT ID
user_data_user_agent \| String User Agent
user_data_windows_aid \| String Windows AID
user_data_device_locale \| String Device Locale
user_data_carrier_name \| String Carrier Name
user_data_opted_in_status \| String Whether user opted in to ATT or not

Branch Available Fields

app_id | Long

App ID (capitalize ID in Liveview)

app_name | String

App Name

attributed | Boolean

Attributed

content_items | ArrayStruct

Content Items

custom_data | MapStringString

Custom Data

customer_event_alias | String

Customer Event Alias

days_from_last_attributed_touch_to_event | Integer

Days From Last Attributed Touch To Event

deep_linked | Boolean

Deep Linked

di_match_click_token | Long

DI Match Click Token

event_data_ad_type | enum { BANNER, INTERSTITIAL, REWARDED_VIDEO, NATIVE }

Ad Type

event_data_affiliation | String

Affiliation

event_data_coupon | String

Coupon

event_data_currency | String

Currency

event_data_description | String

Event Description

event_data_exchange_rate | Double

Exchange Rate

event_data_revenue | Double

Revenue

event_data_revenue_in_usd | Double

Revenue In USD

event_data_search_query | String

Search Query

event_data_shipping | Double

Shipping

event_data_tax | Double

Tax

event_data_transaction_id | String

Transaction ID

event_timestamp | Long

Event Timestamp

existing_user | Boolean

Existing User

external_intent_uri | String

External Intent URI

first_event_for_user | Boolean

First Event For User

hash_version | String

Hash Version

hours_from_last_attributed_touch_to_event | Integer

House From Last Attributed Touch To Event

id | String

install_activity_attributed | Boolean

Install Attributed

install_activity_data_has_clicked_ad | Boolean

Install Has Clicked Ad

install_activity_data_has_clicked_email | Boolean

Install Has Clicked Email

install_activity_timestamp | Long

Install Timestamp

install_activity_touch_data_additional_data_tilde_ad_id | Long

Install Ad ID

install_activity_touch_data_additional_data_tilde_ad_set_id | Long

Install Ad Set ID

install_activity_touch_data_additional_data_tilde_campaign_id | Long

Install Campaign ID

install_activity_touch_data_additional_data_tilde_creative_id | Long

Install Creative ID

install_activity_touch_data_dollar_3p | String

Install Partner 3p Value

install_activity_touch_data_plus_via_features | String

Install Features

install_activity_touch_data_plus_web_format | String

Install Web Format

install_activity_touch_data_tilde_ad_name | String

Install Ad Name

install_activity_touch_data_tilde_ad_set_name | String

Install Ad Set Name

install_activity_touch_data_tilde_advertising_partner_id | Long

Install Ad Partner ID

install_activity_touch_data_tilde_advertising_partner_name | String

Install Ad Partner

install_activity_touch_data_tilde_agency | String

Install Agency

install_activity_touch_data_tilde_agency_id | Long

Install Agency ID

install_activity_touch_data_tilde_campaign | String

Install Campaign

install_activity_touch_data_tilde_channel | String

Install Channel

install_activity_touch_data_tilde_creative_name | String

Install Creative Name

install_activity_touch_data_tilde_customer_ad_name | String

Install Customer Ad Name

install_activity_touch_data_tilde_customer_ad_set_name | String

Install Customer Ad Set Name

install_activity_touch_data_tilde_customer_campaign | String

Install Customer Campaign

install_activity_touch_data_tilde_customer_keyword | String

Install Customer Keyword

install_activity_touch_data_tilde_customer_placement | String

Install Customer Placement

install_activity_touch_data_tilde_customer_secondary_publisher | String

Install Customer Secondary Publisher

install_activity_touch_data_tilde_customer_sub_site_name | String

Install Customer Sub Site Name

install_activity_touch_data_tilde_feature | String

Install Feature

install_activity_touch_data_tilde_journey_name | String

Install Journey Name

install_activity_touch_data_tilde_keyword | String

Install Keyword

install_activity_touch_data_tilde_placement | String

Install Placement

install_activity_touch_data_tilde_secondary_publisher | String

Install Secondary Publisher

install_activity_touch_data_tilde_stage | String

Install Stage

install_activity_touch_data_tilde_tags | String

Install Tags

install_activity_touch_data_tilde_view_name | String

Install View Name

install_activity_touch_type | String

Install Touch Type

last_attributed_touch_data_custom_fields | String

Last Attributed Touch Custom Fields

last_attributed_touch_data_dollar_3p | String

Ad Partner (3p)

last_attributed_touch_data_plus_current_feature | String

Current Feature

last_attributed_touch_data_tilde_id | Long

Last Attributed Touch ID

last_attributed_touch_data_plus_touch_id | String

Last Attributed Touch Touch ID

last_cta_view_data_plus_touch_id | String

Last CTA View Touch ID

last_attributed_touch_data_plus_via_features | ArrayString

Via Features

last_attributed_touch_data_plus_web_format | String

Web Format

last_attributed_touch_data_tilde_ad_id | String

Ad ID

last_attributed_touch_data_tilde_ad_name | String

Ad Name

last_attributed_touch_data_tilde_ad_set_id | String

Ad Set ID

last_attributed_touch_data_tilde_ad_set_name | String

Ad Set Name

last_attributed_touch_data_tilde_advertising_account_name | String

Advertising Account Name

last_attributed_touch_data_tilde_advertising_account_id | String

Advertising Account ID

last_attributed_touch_data_tilde_advertising_partner_id | String

Ad Partner ID

last_attributed_touch_data_tilde_advertising_partner_name | String

Ad Partner

last_attributed_touch_data_tilde_agency | String

Agency

last_attributed_touch_data_tilde_agency_id | String

Agency ID

last_attributed_touch_data_tilde_banner_dimensions | String

Banner Dimensions

last_attributed_touch_data_tilde_branch_ad_format | String

Branch Ad Format

last_attributed_touch_data_tilde_campaign | String

Campaign

last_attributed_touch_data_tilde_campaign_id | String

Campaign ID

last_attributed_touch_data_tilde_campaign_type | String

Campaign Type

last_attributed_touch_data_tilde_channel | String

Channel

last_attributed_touch_data_tilde_creative_name | String

Creative Name

last_attributed_touch_data_tilde_creative_id | String

Creative ID

last_attributed_touch_data_tilde_customer_ad_name | String

Customer Ad Name

last_attributed_touch_data_tilde_customer_ad_set_name | String

Customer Ad Set Name

last_attributed_touch_data_tilde_customer_campaign | String

Customer Campaign

last_attributed_touch_data_tilde_customer_keyword | String

Customer Keyword

last_attributed_touch_data_tilde_customer_placement | String

Customer Placement

last_attributed_touch_data_tilde_customer_secondary_publisher | String

Customer Secondary Publisher

last_attributed_touch_data_tilde_customer_sub_site_name | String

Customer Sub Site Name

last_attributed_touch_data_tilde_external_touch_id | String

External Touch ID

last_attributed_touch_data_tilde_feature | String

Feature

last_attributed_touch_data_tilde_journey_id | String

Journey ID

last_attributed_touch_data_tilde_journey_name | String

Journey Name

last_attributed_touch_data_tilde_keyword | String

Keyword

last_attributed_touch_data_tilde_keyword_id | String

Keyword ID

last_attributed_touch_data_tilde_optimization_model | String

Optimization Model

last_attributed_touch_data_tilde_placement | String

Placement

last_attributed_touch_data_tilde_placement_id | String

Placement ID

last_attributed_touch_data_tilde_secondary_ad_format | String

Secondary Ad Format

last_attributed_touch_data_tilde_secondary_publisher | String

Secondary Publisher

last_attributed_touch_data_tilde_secondary_publisher_id | String

Secondary Publisher ID

last_attributed_touch_data_tilde_stage | String

Stage

last_attributed_touch_data_tilde_sub_site_name | String

Sub Site Name

last_attributed_touch_data_tilde_tags | ArrayString

Branch Available SKAdNetwork Message Fields

id \| varchar SkAdNetwork Message ID
body_transaction_id \| varchar SKAdNetwork Transaction ID
body_version \| varchar SKAdNetwork Version
body_ad_network_id \| varchar SKAdNetwork Ad Network ID
body_campaign_id \| integer SKAdNetworkCampaign ID
body_app_id \| bigint SKAdNetwork App ID (App Store ID)
body_attribution_signature \| varchar Body Attribution Signature
body_redownload \| boolean SKAdNetwork Redownload
body_source_app_id \| bigint SKAdNetwork Source App ID
body_conversion_value \| integer Body Conversion Value
body_fidelity_type \| integer Body Fidelity Type
last_attributed_touch_data_tilde_ad_set_name \| varchar Ad Partner Ad Set Name
last_attributed_touch_data_tilde_ad_set_id \| varchar Ad Partner Ad Set ID
last_attributed_touch_data_tilde_campaign_id \| varchar Ad Partner Campaign ID
last_attributed_touch_data_tilde_campaign \| varchar Ad Partner Campaign Name
invalid_reason \| varchar Invalid Reason
timestamp \| bigint Timestamp when Branch received data
event_timezone_adjusted_day \| bigint Timestamp provided by Partner
annotation_dollar_3p \| varchar Annotation Dollar 3P
annotation_conversion_value_mapped_value \| varchar Annotation Conversion Vale Mapped Value
annotation_customer_event_alias \| varchar Annotation Customer Event Alias
annotation_revenue_lower \| varchar Annotation Revenue Lower Bound
annotation_revenue_upper \| varchar Annotation Revenue Upper Bound
app_id \| bigint Branch App ID
organization_id \| bigint Branch Organization ID

id | varchar

SkAdNetwork Message ID

body_transaction_id | varchar

SKAdNetwork Transaction ID

body_version | varchar

SKAdNetwork Version

body_ad_network_id | varchar

SKAdNetwork Ad Network ID

body_campaign_id | integer

SKAdNetworkCampaign ID

body_app_id | bigint

SKAdNetwork App ID (App Store ID)

body_attribution_signature | varchar

Body Attribution Signature

body_redownload | boolean

SKAdNetwork Redownload

body_source_app_id | bigint

SKAdNetwork Source App ID

body_conversion_value | integer

Body Conversion Value

body_fidelity_type | integer

Body Fidelity Type

last_attributed_touch_data_tilde_ad_set_name | varchar

Ad Partner Ad Set Name

last_attributed_touch_data_tilde_ad_set_id | varchar

Ad Partner Ad Set ID

last_attributed_touch_data_tilde_campaign_id | varchar

Ad Partner Campaign ID

last_attributed_touch_data_tilde_campaign | varchar

Ad Partner Campaign Name

invalid_reason | varchar

Invalid Reason

timestamp | bigint

Timestamp when Branch received data

event_timezone_adjusted_day | bigint

Timestamp provided by Partner

annotation_dollar_3p | varchar

Annotation Dollar 3P

annotation_conversion_value_mapped_value | varchar

Annotation Conversion Vale Mapped Value

annotation_customer_event_alias | varchar

Annotation Customer Event Alias

annotation_revenue_lower | varchar

Annotation Revenue Lower Bound

annotation_revenue_upper | varchar

Annotation Revenue Upper Bound

app_id | bigint

Branch App ID

organization_id | bigint

Branch Organization ID

🚧
IP Discrepancies
Geographic data, such as country and city, may not be available for a very small percentage of events where the IP cannot be resolved to a location.

TUNE Available Fields

🚧
IP Discrepancies
Geographic data, such as country and city, may not be available for a very small percentage of events where the IP cannot be resolved to a location.

🚧
Discontinued Fields
Some fields have very limited value to our customers and as such have been discontinued. Discontinued fields will not be available via the Custom Export API. Please work with your CSM or our Support team if you have questions or concerns.

📘
Info
Branch does not support exports of the infrequently-used update and postbacks TUNE topics.

ad_network_id Ad Network ID
ad_network_name Ad Network Name
advertiser_id Advertiser ID
advertiser_name Advertiser Name
advertiser_opt_out Advertiser Opt Out
advertiser_ref_id Advertiser Ref ID
advertiser_sub_ad_name My Ad Name
advertiser_sub_ad_ref My Ad Ref
advertiser_sub_adgroup_name My Adgroup Name
advertiser_sub_adgroup_ref My Adgroup Ref
advertiser_sub_campaign_name My Campaign Name
advertiser_sub_campaign_ref My Campaign Ref
advertiser_sub_keyword_name My Keyword Name
advertiser_sub_keyword_ref My Keyword Ref
advertiser_sub_placement_name My Placement Name
advertiser_sub_placement_ref My Placement Ref
advertiser_sub_publisher_name My Publisher Name
advertiser_sub_publisher_ref My Publisher Ref
advertiser_sub_site_name My Site Name
advertiser_sub_site_ref My Site Ref
agency_id Agency ID
agency_name Agency Name
app_version App Version
attribute_sub1 Attribute Sub1
attribute_sub2 Attribute Sub2
attribute_sub3 Attribute Sub3
attribute_sub4 Attribute Sub4
attribute_sub5 Attribute Sub5
branch_app_id Branch App ID
click_created Click Created
country_code Country Code
country_name Country Name
created Created
currency_code Currency Code
device_brand Device Brand
device_carrier Device Carrier
device_ip Device IP
device_model Device Model
device_type Device Type
download_date Download Date
event_type Event Type
existing_user Existing User
google_ad_tracking Google Ad Tracking Enabled
google_aid Google Advertising ID
id ID
impression_created Impression Created
install_created Install Created
install_date Install Date
install_publisher_name Install Publisher Name
ios_ad_tracking iOS Ad Tracking Enabled
ios_ifa iOS IDFA
ios_ifv iOS IDFV
ip IP
is_view_through Is View Through
language Language
latitude Latitude
longitude Longitude
mat_id Mat ID
metro_code Metro Code
os_id OS ID
os_jailbroke Jailbroken
os_version OS Version
package_name Package Name
platform_aid Platform AID
postal_code Postal Code
publisher_adgroup_id Publisher Adgroup ID
publisher_id Publisher ID
publisher_name Publisher Name
publisher_ref_id Publisher Ref ID
publisher_sub_ad_id Publisher Sub Ad ID
publisher_sub_ad_name Publisher Sub Ad Name
publisher_sub_ad_ref Publisher Sub Ad Ref
publisher_sub_adgroup_name Publisher Sub Adgroup Name
publisher_sub_adgroup_ref Publisher Sub Adgroup Ref
publisher_sub_campaign_id Publisher Sub Campaign ID
publisher_sub_campaign_name Publisher Sub Campaign Name
publisher_sub_campaign_ref Publisher Sub Campaign Ref
publisher_sub_channel Publisher Sub Channel
publisher_sub_feature Publisher Sub Feature
publisher_sub_keyword_id Publisher Sub Keyword ID
publisher_sub_keyword_name Publisher Sub Keyword Name
publisher_sub_keyword_ref Publisher Sub Keyword Ref
publisher_sub_placement_id Publisher Sub Placement ID
publisher_sub_placement_name Publisher Sub Placement Name
publisher_sub_placement_ref Publisher Sub Placement Ref
publisher_sub_publisher_id Publisher Sub Publisher ID
publisher_sub_publisher_name Publisher Sub Publisher Name
publisher_sub_publisher_ref Publisher Sub Publisher Ref
publisher_sub_site_name Publisher Sub Site Name
publisher_sub1 Publisher Sub1
publisher_sub2 Publisher Sub2
publisher_sub3 Publisher Sub3
publisher_sub4 Publisher Sub4
publisher_sub5 Publisher Sub5
publisher_sub_stage Publisher Sub Stage
publisher_sub_tags Publisher Sub Tags
region_name Region Name
revenue Revenue
revenue_usd Revenue USD
sdk SDK
sdk_version SDK Version
search_string Search String
session_datetime Session Datetime
site_event_id Site Event ID
site_event_name Site Event Name
site_event_type Site Event Type
site_id Site ID
site_name Site Name
stat_click_id Click ID
stat_impression_id Impression ID
transaction_id Transaction ID
user_agent User Agent
user_id User ID
windows_aid Windows Advertising ID
wurfl_brand_name Brand Name
wurfl_device_os Device OS
wurfl_device_os_version Device OS Version
wurfl_model_name Model Name

ad_network_id

Ad Network ID

ad_network_name

Ad Network Name

advertiser_id

Advertiser ID

advertiser_name

Advertiser Name

advertiser_opt_out

Advertiser Opt Out

advertiser_ref_id

Advertiser Ref ID

advertiser_sub_ad_name

My Ad Name

advertiser_sub_ad_ref

My Ad Ref

advertiser_sub_adgroup_name

My Adgroup Name

advertiser_sub_adgroup_ref

My Adgroup Ref

advertiser_sub_campaign_name

My Campaign Name

advertiser_sub_campaign_ref

My Campaign Ref

advertiser_sub_keyword_name

My Keyword Name

advertiser_sub_keyword_ref

My Keyword Ref

advertiser_sub_placement_name

My Placement Name

advertiser_sub_placement_ref

My Placement Ref

advertiser_sub_publisher_name

My Publisher Name

advertiser_sub_publisher_ref

My Publisher Ref

advertiser_sub_site_name

My Site Name

advertiser_sub_site_ref

My Site Ref

agency_id

Agency ID

agency_name

Agency Name

app_version

App Version

attribute_sub1

Attribute Sub1

attribute_sub2

Attribute Sub2

attribute_sub3

Attribute Sub3

attribute_sub4

Attribute Sub4

attribute_sub5

Attribute Sub5

branch_app_id

Branch App ID

click_created

Click Created

country_code

Country Code

country_name

Country Name

created

Created

currency_code

Currency Code

device_brand

Device Brand

device_carrier

Device Carrier

device_ip

Device IP

device_model

Device Model

device_type

Device Type

download_date

Download Date

event_type

Event Type

existing_user

Existing User

google_ad_tracking

Google Ad Tracking Enabled

google_aid

Google Advertising ID

impression_created

Impression Created

install_created

Install Created

install_date

Install Date

install_publisher_name

Install Publisher Name

ios_ad_tracking

iOS Ad Tracking Enabled

ios_ifa

iOS IDFA

ios_ifv

iOS IDFV

is_view_through

Is View Through

language

Language

latitude

Latitude

longitude

Longitude

mat_id

Mat ID

metro_code

Metro Code

os_id

OS ID

os_jailbroke

Jailbroken

os_version

OS Version

package_name

Package Name

platform_aid

Platform AID

postal_code

Postal Code

publisher_adgroup_id

Publisher Adgroup ID

publisher_id

Publisher ID

publisher_name

Publisher Name

publisher_ref_id

Publisher Ref ID

publisher_sub_ad_id

Publisher Sub Ad ID

publisher_sub_ad_name

Publisher Sub Ad Name

publisher_sub_ad_ref

Publisher Sub Ad Ref

publisher_sub_adgroup_name

Publisher Sub Adgroup Name

publisher_sub_adgroup_ref

Publisher Sub Adgroup Ref

publisher_sub_campaign_id

Publisher Sub Campaign ID

publisher_sub_campaign_name

Publisher Sub Campaign Name

publisher_sub_campaign_ref

Publisher Sub Campaign Ref

publisher_sub_channel

Publisher Sub Channel

publisher_sub_feature

Publisher Sub Feature

publisher_sub_keyword_id

Publisher Sub Keyword ID

publisher_sub_keyword_name

Publisher Sub Keyword Name

publisher_sub_keyword_ref

Publisher Sub Keyword Ref

publisher_sub_placement_id

Publisher Sub Placement ID

publisher_sub_placement_name

Publisher Sub Placement Name

publisher_sub_placement_ref

Publisher Sub Placement Ref

publisher_sub_publisher_id

Publisher Sub Publisher ID

publisher_sub_publisher_name

Publisher Sub Publisher Name

publisher_sub_publisher_ref

Publisher Sub Publisher Ref

publisher_sub_site_name

Publisher Sub Site Name

publisher_sub1

Publisher Sub1

publisher_sub2

Publisher Sub2

publisher_sub3

Publisher Sub3

publisher_sub4

Publisher Sub4

publisher_sub5

Publisher Sub5

publisher_sub_stage

Publisher Sub Stage

publisher_sub_tags

Publisher Sub Tags

region_name

Region Name

revenue

Revenue

revenue_usd

Revenue USD

sdk

SDK

sdk_version

SDK Version

search_string

Search String

session_datetime

Session Datetime

site_event_id

Site Event ID

site_event_name

Site Event Name

site_event_type

Site Event Type

site_id

Site ID

site_name

Site Name

stat_click_id

Click ID

stat_impression_id

Impression ID

transaction_id

Transaction ID

user_agent

User Agent

user_id

User ID

windows_aid

Windows Advertising ID

wurfl_brand_name

Brand Name

wurfl_device_os

Device OS

wurfl_device_os_version

Device OS Version

wurfl_model_name

Model Name

Field Value Changes

When exporting the following fields, you will notice a difference between the value TUNE provides vs the value Branch provides.

Country Name
- TUNE: Korea - South
- Branch: Republic of Korea
Region Name
- TUNE: seoul teugbyeoisi
- Branch: Seoul
City Code
- TUNE: 2261 (Seoul)
- Branch: 1835848 (Seoul)
Language
- TUNE: ko, ko-KR, en-KR
- Branch: KO

Including Fields from Related Data Objects

Related objects no longer use periods . to access the properties on the object. Rather, field names use underscores _ only.

For example, site_event.id will now be exported as site_event_id.

Cthulhu Filter Specification

Cthulhu is a prefix notation syntax written in JSON for specifying filters on records (usually column-based records).

Purpose
Easily parses into an abstract syntax tree.

Glossary
any - any valid json basic value (number, string)
... - previous item in a list can repeat as many times as necessary

Name	Spec	Example	SQL Equivalent
eq	["eq",<column:string>, <value:any>]	["eq","x", 1]	x= 1
gt	["gt",<column:string>, <value:any>]	["gt","x", 1]	x> 1
gte	["gte",<column:string>, <value:any>]	["gte","x", 1]	x >= 1
lt	["lt",<column:string>, <value:any>]	["lt","x", 1]	x< 1
lte	["lte",<column:string>, <value:any>]	["lte","x", 1]	x <= 1
like	["like",<column:string>, <value:regex>]	["like", "x", ". *foobar"]	x LIKE "% foobar"
between	["between",<column:string>, <lower:any>, <upper:any>]	["between", "x",1, 2]	x BETWEEN 1 AND 2 x >= 1 AND x <= 2
In	["in", <column: string>, <value: any>, ...]	["in","x", 1,2, 3]	x IN (1,2,3)
and	["and", , ...]	["and",["gt","x", 1],["lt","x", 2]]	x> 1 AND x < 2
or	["or", , ...]	["or",["eq","x", 1],["eq", "x", 2]]	x = 1 OR x= 2
not	["not",]	["not",["eq","x", 1]]	x != 1
array_contains	["array_contains", , ]	["array_contains","last_attributed_touch_data_tilde_tags","Share"]	array_contains(array(1, 2, 3), 2)

Overview

📘Branch & TUNE Export Functionality

🚧Data Changes Post iOS 14.5

🚧Exporting from Test Environments is not supported

Authentication

Rate Limits

🚧Repeated requests within 60 minutes will be cached

Export Access

Third Party Access

Providing Agencies API Access

🚧Agency-Tagged Data

Available Topics to Export

Available Fields

Accessing via Branch Dashboard

📘

Accessing via API

Endpoint Definitions

Building the Export Request

Sample Export Request

Sample Export Response

Building the Download Export Request

Sample Download Export Request

Sample Download Export Response

Appendix

Branch Available Topics

🚧Blocked Topics

TUNE Available Topics

Branch Available EO Fields

Branch Available SKAdNetwork Message Fields

🚧IP Discrepancies

TUNE Available Fields

🚧IP Discrepancies

🚧Discontinued Fields

📘Info

Field Value Changes

Including Fields from Related Data Objects

Cthulhu Filter Specification

Filters

📘
Branch & TUNE Export Functionality

🚧
Data Changes Post iOS 14.5

🚧
Exporting from Test Environments is not supported

🚧
Repeated requests within 60 minutes will be cached

🚧
Agency-Tagged Data

🚧
Blocked Topics

🚧
IP Discrepancies

🚧
IP Discrepancies

🚧
Discontinued Fields

📘
Info