每日数据导出(Daily Exports)

概述

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

一些重要的注意事项:

  • 只能检索过去7天的数据
  • 数据仅在一天结束后显示,因为每24小时处理一次
  • 您的App被列入数据导出白名单日期之前的数据将不可见。成功注册后,将在下一个UTC时间的天生成数据。
  • 数据仅对您的活动密钥(而不是测试密钥)可见。
  • 与SAN相关的点击数据(例如Google Ads)只能在广告系列级而非设备级查看。

7天后的数据散列

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

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

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

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

每日导出API包含在分公司的数据馈送产品,该产品可根据分行购买定价表 ,并且可在无需额外付费,谁是在启动和启动计划,客户Journeys(网站向App引流解决方案) 通用电子邮件通用广告

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

第三方访问

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

要求

  • 您必须具有Data Feeds 订阅。
  • 打开 Data Feeds Manager page上的 Data Export API 滑块。
  • 要访问API,您必须具有Sensitive DataExport 访问权限。

通过Branch仪表板访问

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

CSV 发送

您通过仪表板导出的所有数据都将包含在电子邮件的 CSV 附件中。请确保您在 Account Settings 内的电子邮件地址是最新的。

请求导出:

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

图像

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

通过API访问

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

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

基本URL
https://api2.branch.io/v3/export/

终点

查询参数

branch_key 需要
原始应用程序的Branch键

branch_secret 需要
原始应用程序的Branch密钥

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 '的基于人员归因提供支持。有关这些导出中包含的事件的详尽列表以及每个事件的更详细定义,请参阅事件本体数据模式

信息

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

IP 地址差异

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

支持中心

时间限制

只有在其发生的日期之后的7天内,数据才能通过 API 获得。如果您需要记录超过7天的数据,请在定期导出和存储数据。

导出超过 7 天前

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

手动数据转储

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

更新5 天前

每日数据导出(Daily Exports)


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

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