Custom Exports API

👍

Try it!

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

Overview

Benefits of Custom Exports API

• 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 (this page).

API Limitations

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

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

Prerequisites & API Access

In order to use the Custom Exports API, you need to have completed the following:

1. Created a Branch Dashboard
2. Implemented the Branch SDK into your mobile app (iOS | Android)
   • Track events.
3. Opt into sharing 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.

🚧

Data Changes Post iOS

Opt-ins will affect your final install count. We recommend using 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

4. Logged into the Branch Dashboard with the Sensitive Data and Export Access Permission enabled.

대행사에 API 접근권한 제공하기

계정의 API 키에 접근할 수 있는 모든 사용자는 Branch의 Custom Exports API (및 필터링을 거치지 않은 로그 레벨 데이터)에 접근할 수 있습니다. 따라서 써드파티를 Branch대시보드의 사용자로 초대할 때 API키를 열람할 수 있는 권한을 제공하지 않는 것이 좋습니다.

🚧

Data Purge

• Branch will purge last-attributed data after 60 days.

광고 캠페인을 운영하는 에이전시와 협력하며 후속 데이터를 내보낼 수 있는 액세스 권한을 부여하려는 경우 커스텀 Export API에 대한 액세스 권한을 제공할 수 있습니다. 대행사와 협력하여 광고 캠페인을 운영하고 이를 통해 발생한 데이터에 대한 추출할 수 있게 한다면 Custom Exports API에 대한 접근권한을 제공할 수 있습니다.

대행사에게 Custom Exports API에 대한 접근권한을 제공하려면 다음과 같이 진행할 수 있습니다.

1. In the left-hand navigation, under Configure, click on Account Settings.
2. On the Account Settings page, click on the Agencies tab.
3. 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.
4. In the Edit Agency Team Member modal:
   1. Under Access Level, check the Export box.
   2. Under Permissions, check the Sensitive Data box.
5. 선택 사항: 데이터 필터 추가
   1. Under Data Filters, toggle any necessary data filters on/blue. Exported data will be filtered accordingly.
6. Save를 클릭합니다.

🚧

대행사 태그 데이터

Only show agency-tagged data 필터를 활성화하지 않은 경우 대행사 맴버는 해당 대행사 데이터뿐만 아니라 모든 캠페인에 대한 민감한 데이터를 추출할 수 있게 됩니다

권한인증

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).

API Usage

Create Export Request

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

Request Headers:

Request Body Parameters:

Response Body Parameters:

Example Request/Response:

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]
            }'

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

Response Codes:

Get Export Request

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

Request Headers:

Response Path Parameters

Request Query Parameters:

Response Body Parameters

Example Request/Response:

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>"

{"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"}

Response Codes:

Status Values:

부록

Available EO Fields

Available SKAdNetwork Message Fields

🚧

IP와 위치정보의 불일치

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

Available Topics

🚧

차단된 토픽(Blocked Topics)

Branch에서는 요청 시점기준 최대 60일이전까지의 차단된 토픽을 추출할 수 있습니다.

Cthulhu filter 규격

Cthulhu는 레코드(일반적으로 컬럼 기반의 레코드)에 필터를 지정하기 위해 JSON으로 작성된 접두부 표기법 구문입니다.

목적
쉽게 추상 구문 트리로 파싱합니다.

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