日输出和 API

概述

Branch的Daily Exports直接提取精细的Branch事件数据。您可以通过Branch仪表板中的Daily Exports部分或直接通过API进行操作。

一些重要的注意事项:

  • 只能在最近7天内检索数据
  • 由于数据每24小时处理一次,因此只会在一天结束后显示
  • 列入白名单日期之前的数据将不可见。注册后,将在下一个UTC天或下一个UTC天生成数据。
  • 数据仅对您的活动密钥(而不是测试密钥)可见。
  • 与SAN相关的点击数据(例如Google Ads)可以在广告系列级而非设备级找到。

❗️

7天后的数据散列

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

这意味着,如果要通过仪表板的CSV导出或通过请求手动数据转储来导出7天以上的数据,则这些字段将不再包含原始值。

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

📘

数据导出(Data Feeds)是 Premium 解决方案

Daily Export API包含在Branch的数据馈送产品中,可以根据Branch的定价表购买该产品,并且正在为“旅程” ,“通用电子邮件”或“ Universal Ads”启动和启动计划的客户免费使用。

如果没有数据文件,您仍然可以直接通过“来源”或“ CSV导出”从分支仪表板以CSV格式导出分支数据。

❗️

第三方访问

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

要求

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

通过分支仪表板访问

您可以直接使用Branch仪表板中的Daily Exports部分来通过CSV请求适当的数据,而不是直接访问Daily Export API。

📘

CSV传送

您通过信息中心导出的所有数据都将包含在电子邮件的CSV附件中。请确保您的电子邮件地址为Account Settings

请求出口:

  1. 在左侧导航的Setup & Testing部分下,单击Data Import & Export ,然后单击Exports
  2. Daily Exports页上,选择要导出数据的时间段。
    • 最近1天
    • 最近三天
    • 最近7天
    • 自订
  3. 选择要导出的事件类型:
  • 分别点击相应的 Download arrow
  • 单击Export All按钮进行汇总。

图片图片

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

通过API访问

为了使用此API,您必须具有应用ID和分支公共密钥。

您可以在“帐户设置”中找到密钥。

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

终点

查询参数

branch_key 必填
原始应用程序的分支密钥

branch_secret 必填
原始应用程序的分支秘密密钥

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命令提示符格式

请注意,如果您尝试在运行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文件都将被压缩。下例中的每个键都可能不会出现在响应中,具体取决于您在指定日期内是否有该主题的任何事件。

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

通过数据Feed进行的所有导出均由Branch的基于人员归因提供支持。有关这些导出中包含的事件的详尽列表以及每个事件的更详细定义,请参见Event Ontology Data Schema

📘

信息

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

❗️

知识产权差异

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

支持中心

时间限制

数据自发布之日起仅7天可通过API获得。如果您需要记录超过7天的数据,请在您的系统中设置定期导出和存储数据。

出口超过7天

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

📘

手动数据转储

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

5个月前更新


推荐的后续步骤

每日导出常见问题

日输出和 API


建议的编辑仅限于API参考页

您只能建议对Markdown正文内容进行修改,而不能建议对API规范进行修改。