👍

Try it!

Try out the Daily Exports API using your Branch data via the API reference here

Overview

Benefits of Daily Exports API

Branch’s Daily Exports pull granular Branch event data directly. You can do so either via the Daily Exports section in your Branch dashboard OR via API directly.

API Limitations

Limitation

Details

Data Availability

데이터는 24시간마다 처리되므로 하루가 끝난 후에만 표시됩니다.

Max number of days that can be queried at a time

7 Days.

Export Window

Rolling 7 day window

Data Visibility

화이트리스트 날짜 이전에는 데이터가 표시되지 않습니다. 등록하면 그 이후 UTC 날에 대한 데이터가 생성됩니다.

Data Visibility for Keys

데이터는 테스트 키가 아닌 라이브 키에 대해서만 표시됩니다.

Click data related to SANs (e.g. Google Ads)

Can be found at the campaign level rather than device level.

Data Purge

Branch will purge last-attributed data after 60 days

Data Hashing

Many fields are hashed, including IP address and advertising identifiers, after 7 days. See Data Hashing for further details.

File Limitations

Multiple files are expected with 200K rows per file when using Daily Exports. If your export has less than 200K rows, there will only be one file.

Prerequisites & API Access

전제 조건

  • You must have a Data Feeds subscription.
  • Toggle on the Data Export API using the slider on the Data Feeds Manager page.
  • To access the API, you must have Sensitive Data and Export access.

Third Party API Access

계정의 API 키에 액세스할 수 있는 모든 유저는 Branch의 Daily Export API (및 필터링 되지 않은 로그 레벨 데이터)에 액세스할 수 있습니다. 따라서 초대 프로세스 중에 민감한 데이터 및 앱 레벨 설정과 같은 API 키를 보는 데 필요한 권한을 써드파티(에이전시와 광고 파트너)에게 제공하지 않는 것이 좋습니다.

권한인증

Calls to the Branch Daily Export API require a branch_key and branch_secret String parameter to be passed with each request.

API Usage

Daily Exports Request

POST
https://api2.branch.io/v3/export
Headers:
Content-Type: application/json
Body: JSON parameters
Host: api2.branch.io

Request Headers:

Header

설명

필수

Content-Type

application/json

Request Body Parameters:

파라미터

설명

필수

branch_key

The Branch key of the originating app.

branch_secret

The Branch secret key of the originating app.

export_date

The UTC date of the requested data export.

Response Body Parameters:

파라미터

유형

사용자 친화적 토픽명

eo_branch_cta_view

Array of Strings

CTA Views

eo_click

Array of Strings

Click

eo_commerce_event

Array of Strings

Commerce Events

eo_content_event

Array of Strings

Content Events

eo_custom_event

Array of Strings

Custom Events

eo_impression

Array of Strings

Impressions

eo_install

Array of Strings

Install

eo_open

Array of Strings

Open

eo_pageview

Array of Strings

Pageviews

eo_reinstall

Array of Strings

Reinstall

eo_sms_sent

Array of Strings

전송된 문자 메시지

eo_user_lifecycle_event

Array of Strings

User Lifecycle Events

eo_web_session_start

Array of Strings

Web Session Start

eo_dismissal

Array of Strings

Dismissal

Example Request/Response:

curl --request POST \
     --url https://api2.branch.io/v3/export \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --data '
{
     "branch_key": "key_live_xxxxxxxxxxxx",
     "branch_secret": "secret_live_xxxxxxxxxx",
     "export_date": "2022-06-01"
}
{
 "eo_branch_cta_view": <Array of String(s)>,
  "eo_click": <Array of String(s)>,
  "eo_commerce_event": <Array of String(s)>,
  "eo_content_event": <Array of String(s)>,
  "eo_custom_event": <Array of String(s)>,
  "eo_impression": <Array of String(s)>,
  "eo_install": <Array of String(s)>,
  "eo_open": <Array of String(s)>,
  "eo_pageview": <Array of String(s)>,
  "eo_reinstall": <Array of String(s)>,
  "eo_sms_sent": <Array of String(s)>,
  "eo_user_lifecycle_event": <Array of String(s)>,
  "eo_web_session_start": <Array of String(s)>,
  "eo_web_to_app_auto_redirect": <Array of String(s)>,
  "eo_dismissal": <Array of String(s)>
}

📘

Windows 명령 프롬프트 형식

Please note that if you are trying to run this curl command in Command Prompt on a machine running Windows, you will need to change ' to " and escape the " in curly brackets with a . Here is a final example:

curl --request POST \
     --url https://api2.branch.io/v3/export \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --data "
{\"branch_key\": \"key_live_xxxxxxxxxxxx\",\"branch_secret\": \"secret_live_xxxxxxxxxx\",\"export_date\": \"2022-06-01\"}"

The response payload will be in JSON format and for each export, it will have an array of paths to files on S3 to download.

  • Note that there may be multiple files (depending on the size of the day's export) and that each CSV file will be gzipped.
  • Each of the keys in the example above may not be present in the response depending on if you had any events for that topic for the specified day.

All exports via Data Feeds are powered by Branch's People-Based Attribution. For an exhaustive list of events included in these exports and more detailed definitions of each event, please see the Event Ontology Data Schema.

Response Codes:

Response Code

설명

200

Status of aggregate export

400

Authentication Failed

부록

Data Hashing

GDPR 및 기타 데이터 보호법과 관련된 내부 정책에 따라 IP 주소 및 광고 식별자를 포함한 많은 필드를 7일 후에 해시합니다.

즉, 대시보드의 CSV Export를 이용하거나 수동 데이터 덤프를 요청하여 7일이 지난 데이터를 내보내려는 경우 해당 필드에 더 이상 원래 값이 포함되지 않습니다.

따라서 항상 7일 이내에 원시 데이터를 내보내는 것이 좋습니다.

Daily Download Availability

A full day's files will be available on our S3 bucket at that location to download around 4:00 am UTC. It will return a blank array from S3 for any empty files until the UTC day is over and the data has been transferred to S3, therefore it is recommended you schedule any ETLs to fetch the data for the previous day around 7:00 am UTC.

IP와 위치정보의 불일치

IP로 위치를 분석할 수 없는 매우 적은 비율의 이벤트에 대해서는 국가 및 도시와 같은 지리 데이터를 사용하지 못할 수 있습니다.

시간 제한

데이터는 게시일 이후 6개월 동안만 API를 통해 이용 가능합니다. 6개월 전의 데이터 기록이 필요한 경우, 반복 추출을 설정하고 시스템에 데이터를 저장하십시오.

7일 이상 내보내기

GDPR 및 기타 데이터 보호법과 관련된 내부 정책에 따라 IP 주소 및 광고 식별자를 포함한 많은 필드를 7일 후에 해시합니다. 즉, 대시보드의 CSV Export를 이용하거나 수동 데이터 덤프를 요청하여 7일이 지난 데이터를 내보내려는 경우 해당 필드에 더 이상 원래 값이 포함되지 않습니다. 따라서 항상 7일 이내에 원시 데이터를 내보내는 것이 좋습니다.

📘

수동 데이터 덤프

수동 데이터 덤프를 완료하는 데 필요한 리소스로 인해 해당 서비스는 Branch 엔터프라이즈 Tier 클라이언트에서만 사용할 수 있습니다.

Daily Exports Fields

id
origin
name
timestamp
timestamp_iso
event_timestamp
store_install_begin_timestamp
referrer_click_timestamp
days_from_install_to_opt_in
days_from_last_attributed_touch_to_event
hours_from_last_attributed_touch_to_event
minutes_from_last_attributed_touch_to_event
seconds_from_last_attributed_touch_to_event
deep_linked
first_event_for_user
customer_event_alias
di_match_click_token
hash_version
request_id
match_guaranteed
custom_data
last_attributed_touch_type
last_attributed_touch_timestamp
last_attributed_touch_timestamp_iso
last_attributed_touch_data_tilde_id
last_attributed_touch_data_tilde_campaign
last_attributed_touch_data_tilde_campaign_id
last_attributed_touch_data_tilde_channel
last_attributed_touch_data_tilde_feature
last_attributed_touch_data_tilde_stage
last_attributed_touch_data_tilde_tags
last_attributed_touch_data_tilde_advertising_partner_name
last_attributed_touch_data_tilde_secondary_publisher
last_attributed_touch_data_tilde_creative_name
last_attributed_touch_data_tilde_creative_id
last_attributed_touch_data_tilde_ad_set_name
last_attributed_touch_data_tilde_ad_set_id
last_attributed_touch_data_tilde_ad_name
last_attributed_touch_data_tilde_ad_id
last_attributed_touch_data_tilde_branch_ad_format
last_attributed_touch_data_tilde_technology_partner
last_attributed_touch_data_tilde_banner_dimensions
last_attributed_touch_data_tilde_placement
last_attributed_touch_data_tilde_keyword_id
last_attributed_touch_data_tilde_agency
last_attributed_touch_data_tilde_optimization_model
last_attributed_touch_data_tilde_secondary_ad_format
last_attributed_touch_data_tilde_journey_name
last_attributed_touch_data_tilde_journey_id
last_attributed_touch_data_tilde_view_name
last_attributed_touch_data_tilde_view_id
last_attributed_touch_data_plus_current_feature
last_attributed_touch_data_plus_via_features
last_attributed_touch_data_dollar_3p
last_attributed_touch_data_plus_web_format
last_attributed_touch_data_custom_fields
last_attributed_touch_data_tilde_keyword
last_attributed_touch_data_tilde_customer_campaign
last_attributed_touch_data_tilde_campaign_type
last_attributed_touch_data_tilde_agency_id
last_attributed_touch_data_plus_touch_id
last_attributed_touch_data_tilde_keyword_match_type
last_attributed_touch_data_tilde_organic_search_url
last_attributed_touch_data_dollar_marketing_title
last_cta_view_timestamp
last_cta_view_timestamp_iso
last_cta_view_data_tilde_id
last_cta_view_data_tilde_campaign
last_cta_view_data_tilde_campaign_id
last_cta_view_data_tilde_channel
last_cta_view_data_tilde_feature
last_cta_view_data_tilde_stage
last_cta_view_data_tilde_tags
last_cta_view_data_tilde_advertising_partner_name
last_cta_view_data_tilde_secondary_publisher
last_cta_view_data_tilde_creative_name
last_cta_view_data_tilde_creative_id
last_cta_view_data_tilde_ad_set_name
last_cta_view_data_tilde_ad_set_id
last_cta_view_data_tilde_ad_name
last_cta_view_data_tilde_ad_id
last_cta_view_data_tilde_branch_ad_format
last_cta_view_data_tilde_technology_partner
last_cta_view_data_tilde_banner_dimensions
last_cta_view_data_tilde_placement
last_cta_view_data_tilde_keyword_id
last_cta_view_data_tilde_agency
last_cta_view_data_tilde_optimization_model
last_cta_view_data_tilde_secondary_ad_format
last_cta_view_data_plus_via_features
last_cta_view_data_dollar_3p
last_cta_view_data_plus_web_format
last_cta_view_data_custom_fields
last_cta_view_data_plus_touch_id
last_cta_view_data_tilde_campaign_type
user_data_os
user_data_os_version
user_data_model
user_data_browser
user_data_geo_country_code
user_data_app_version
user_data_sdk_version
user_data_geo_dma_code
user_data_environment
user_data_platform
user_data_aaid
user_data_idfa
user_data_idfv
user_data_android_id
user_data_limit_ad_tracking
user_data_user_agent
user_data_ip
user_data_developer_identity
user_data_language
user_data_brand
user_data_cross_platform_id
user_data_past_cross_platform_ids
user_data_prob_cross_platform_ids
user_data_os_version_android
user_data_geo_city_code
user_data_geo_city_en
user_data_http_referrer
user_data_installer_package_name
user_data_cpu_type
user_data_screen_width
user_data_screen_height
user_data_build
user_data_internet_connection_type
user_data_opted_in
user_data_opted_in_status
user_data_oaid
event_data_revenue_in_usd
event_data_exchange_rate
event_data_transaction_id
event_data_revenue
event_data_currency
event_data_shipping
event_data_tax
event_data_coupon
event_data_affiliation
event_data_search_query
event_data_description