概述

Branch 的 Daily Exports 直接提取精细的 Branch 事件数据。您可以通过 Branch 操作后台 (Dashboard)中的Daily Exports部分或直接通过 API 进行操作。

一些重要的注意事项：

• 最多只能检索过去 6 个月的数据
• 一次最多只能检索 7 天的数据
• 由于数据每24小时处理一次，因此只会在一天结束后显示
• 列入白名单日期之前的数据将不可见。注册后，将在下一个 UTC 日生成数据。
• 数据仅对您的 live key（而不是 test key）可见。
• 与 SAN 相关的点击数据（例如 Google Ads）可以在 campaign 级而非设备级找到。

❗️

7天后数据哈希

根据与 GDPR 相关的内部政策和其他数据保护法律，我们会在7天后对许多字段进行哈希处理，包括 IP 地址和广告标识符。

这意味着，如果要通过操作后台 (Dashboard)的 CSV 导出或通过请求手动数据转储来导出7天以上的数据，则这些字段将不再包含原始值。

因此，我们强烈建议您确保在7天内导出原始数据。

📘

数据导出（Data Feeds）是 Premium 解决方案

Daily Export API 包含在 Branch 的 Data Feeds（数据对接） 产品中，可以根据 Branch 的价格方案购买该产品，并且正在为 Journeys (站到端引流) ，Universal Email 或 Universal Ads（全域广告归因） 启动和启动计划的客户免费使用。

如果没有 Data Feeds（数据对接），您仍然可以直接通过 Sources 或 CSV 导出从 Branch 操作后台 (Dashboard) 以 CSV 格式导出 Branch 数据。

❗️

第三方访问

任何有权访问帐户的 API keys 的用户都将能够访问 Branch 的 Daily Export API（从而可以访问未经筛选的日志级数据）。因此，我们建议您不要在邀请过程中向第三方（代理商和广告合作伙伴）提供查看 API keys 所需的权限，即敏感数据和应用级设置。

要求

• 您必须拥有 Data Feeds 订阅。
• 使用 Data Feeds Manager page 上的滑块在 Data Export API 上切换。
• 要访问 API，您必须具有 Sensitive Data 和 Export 访问权限。

通过 Branch 操作后台 (Dashboard)访问

您可以直接使用 Branch 操作后台 (Dashboard)中的 Daily Exports 部分来通过 CSV 请求适当的数据，而不是直接访问 Daily Export API。

📘

CSV 传送

您通过操作后台 (Dashboard)导出的所有数据都将包含在电子邮件的 CSV 附件中。请确保您的电子邮件地址为Account Settings 。

请求导出：

1. 在左侧导航的 Setup & Testing 部分下，点击 Data Import & Export ，然后点击 Exports 。
2. 在 Daily Exports 页上，选择要导出数据的时间段。
   • 最近1天
   • 最近3天
   • 最近7天
   • Custom
3. 选择要导出的事件类型：

• 分别点击相应的 Download arrow
• 点击 Export All 键进行汇总。

根据要求，您将收到一封确认电子邮件，其中包含您的请求详细信息。处理完导出文件后，您将收到另一封包含 CSV 附件的电子邮件。请记住，较大的导出需要更多的处理时间。

通过 API 访问

为了使用此 API，您必须具有应用 ID 和 Branch Public Key。

您可以在Account Settings中找到 keys。

Base URL:
https://api2.branch.io/v3/export/

Endpoint

• POSThttps://api2.branch.io/v3/export
• 内容类型：application/json

查询参数

branch_key 必填：
原始应用的 Branch key

branch_secret 必填：
原始应用的 Branch secret key

export_date 必填：
请求的数据导出的 UTC 日期

请求示例：

curl -X POST api2.branch.io/v3/export -H 'content-type:application/json' -d '{"branch_key":"key_live_gcASshuadd7l39m36NhdsDPWRjmkdcgh12jsg1", "branch_secret": "secret_live_ztPsdKIjUtcjkUYF732nsl81HJ75BJqiv24J86", "export_date": "2017-10-21"}'

📘

Windows Command Prompt 格式

请注意，如果您尝试在运行 Windows 的计算机上的命令提示符中运行此 curl 命令，则需要将'更改为"并使用\大括号中的"转义。示例： curl -X POST api2.branch.io/v3/export -H "content-type:application/json" -d "{\"branch_key\":\"key_live_gcASshuadd7l39m36NhdsDPWRjmkdcgh12jsg1\", \"branch_secret\": \"secret_live_ztPsdKIjUtcjkUYF732nsl81HJ75BJqiv24J86\", \"export_date\": \"2017-10-01\"}"

响应

响应有效负载将为 JSON 格式，并且对于每次导出，将具有指向 S3 上要下载的文件的路径的数组。请注意，可能有多个文件（取决于当天导出的大小），并且每个 csv 文件都将被压缩。下例中的每个 key 都可能不会出现在响应中，具体取决于您在指定日期内是否有该主题的任何事件。

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

通过 Data Feeds（数据对接）进行的所有导出均由 Branch 的基于用户的归因模式提供支持。有关这些导出中包含的事件的详尽列表以及每个事件的更详细定义，请参见 Event Ontology Data Schema。

📘

注意事项

一天内的文件将在该位置的 S3 bucket 上提供，可以在世界标准时间（UTC）下午7:00左右下载。在UTC 结束之前，它将为任何空文件从 S3 返回一个空白数组，直到数据已经传输到 S3，因此建议您安排所有 ETL 以在 UTC 7:00 PM（12pm）之前获取前一天的数据（太平洋标准时间）。

❗️

知识产权差异

对于无法将 IP 解析到某个位置的事件，只有很少一部分事件无法使用国家和城市等地理数据。

支持中心

时间限制

数据发布后 6 个月内可通过 API 检索到。如果您需要超过 6 个月的数据记录，请在系统中设置定期导出和存储数据。

导出超过7天

根据与 GDPR 相关的内部政策和其他数据保护法律，我们会在7天后对许多字段进行哈希处理，包括 IP 地址和广告标识符。这意味着，如果要通过操作后台 (Dashboard)的 CSV 导出或通过请求手动数据转储来导出7天以上的数据，则这些字段将不再包含原始值。因此，我们强烈建议您始终在7天内导出原始数据。

📘

手动数据转储

由于完成手动数据转储所需的资源，该服务仅对 Branch Enterprise 层客户端可用。