Remerge 是一个 app 再营销平台。除了我们的面板和分析功能外,客户还能以每日粒度为基础,将基于 JSON 的报告从有效推广的 Remerge Reporting API(Remerge 报告 API)拉到内部商务智能中。
一般
请注意:
-
Remerge Reporting API(Remerge 报告 API)只能通过终端(或通过 API 客户端)访问,如下所示:
- 报告 API 不能通过 Web 浏览器访问。
- Remerge 仅在六个月的有限时间内存储您的数据。因此,为防止您可能希望获取早于所述时间范围的数据,我们建议您维护自己的数据日志。
尺寸
客户端的表现分为六个维度:Timestamp,、Country、app、campaign、Campaign Type和Related Ads。因此,可以轻松地将结果导入,分解成较小的部分,并根据提供的维度将其分发到客户选择的任何商务智能平台上。有关特定参数和字段的更多信息,请参阅下面的索引部分。
端点
可通过以下端点访问 API:
https://api.remerge.io/report
请求与响应
请求参数
Remerge Reporting API(Remerge 报告 API)提供了一个查询数据的简单界面。起始和结束日期是要求提供的唯一参数。
请注意:要获取昨天的数据,您必须确保选择今天的日期作为终止日期(例如,要接收 2021 年 12 月 8 日的数据,请将 2021-12-08 设定为起始日期并将 2021-12-09 设定为终止日期)。
名称 | 内容 | 示例 | 强制性 |
---|---|---|---|
*起始日期 | 报告起始日期(年-月-日) | 2021-12-08 | x |
*结束日期 | 报告结束日期(年-月-日) | 2021-12-09 | x |
维度 |
如果未通过,以逗号分隔的维度列表在默认情况下将总体拆分为受众、国家/地区、推广活动、推广活动类型和广告。可能的维度:受众、国家/地区、推广活动、推广活动类型、广告、广告标签或平台。 |
国家/地区、平台 | |
筛选条件 |
可以按推广活动类型筛选请求,例如 https://api.remerge.io/report?start_date=2022-01-01&end_date=2022-01-02&campaign_type=retargeting |
再营销 |
有效的请求应该如下所示:https://api.remerge.io/report?start_date=2017-01-10&end_date=2017-01-11&dimensions=campaign,ad
注意:
- 我们建议您使用文本编辑程序(如 Sublime 或 Atom)来确保将查询中的所有符号正确地传输到终端。
- 除非您限制请求 URL 中的维度,否则响应将生成所有可能的维度。
授权
示例
登录请求
curl -H 'Content-Type: application/json' -H 'Accept: application/json' -X POST
-d '{"user" : { "email" : "your@email.com","password": "password"}}' https://api.remerge.io/users/sign_in
以 JSON 形式返回所需令牌
{"email":"your@email.com","token":"J-QeJxyza7JH19QUDb4","user_id":1234,"user_name":"Peter Example","user_token":"J-QeJ49Yasdf219QUDb4"}
有效报告所需强制性Headers
名称 | 内容 | 示例 | 强制性 |
---|---|---|---|
Request Header | Content-Type(内容类型) | 'Content-Type: application/json' | x |
Request Header | Acceptance(接收) | 'Accept: application/json' | x |
Request Header | Authorization Token(授权令牌) | 'Authorization: Token user_token="HJn4OYViZv", email="example@mydomain.com"' | x |
请求类型 | POST | POST | x |
请求示例
以下是使用数据传输工具 curl 向 Remerge Reporting API(Remerge 报告 API)发送 POST 请求的示例:
curl -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Authorization: Token user_token="xxXxxXXXXXXx-xXxxXXX", email="example@mydomain.com"'-X POST "https://api.remerge.io/report?start_date=2022-01-01&end_date=2022-01-02&dimensions=audience%2Ccountry%2Ccampaign%2Cad%2Cad_label%2Cplatform"
响应首部字段
Response返回一个 JSON 对象,其中包含一个结果数组和一个元素计数。每个数组元素均包含以下字段:
名称 | 内容 | 示例 | |
---|---|---|---|
timestamp(时间戳) | UTC Timestamp(UTC 时间戳) | 2017-01-11T00:00:00.000Z | |
event.platform(事件平台) | Platform (iOS /Android)(平台(iOS /Android)) | ios | |
event.country(事件国家/地区) | RTB Geo-Information(实时竞价地理信息) | de | |
event.campaign(事件推广) | Internal Remerge Campaign ID(内部 Remerge 推广 ID) | 42 | |
event.campaign_name(事件推广名称) | External Remerge Campaign ID(外部 Remerge 推广 ID) | Test Campaign(测试推广) | |
event.campaign_type | 推广活动类型 | install/Impact/再营销 | |
**event.cost_currency(事件cost币种) | Internal Remerge Campaign Currency(内部 Remerge 推广币种) | EUR(欧元) | |
***event.audience(事件受众) | App Store Reference(苹果应用商店参考) | 12345678 | |
event.ad_id(事件广告 ID) | Creative ID(广告 ID) | 1406561 | |
event.ad_name(事件广告名称) | 图像/视频资源未经过滤的文件名 | banner_300_50.png | |
event.ad_label_id(事件广告标签 ID) | 广告标签 ID | 18304 | |
event.ad_label_name(事件广告标签名称) | 广告标签名称 | non_purchasers_it | |
****event.ad_creative_url(事件广告 URL) | 广告 URL | https://assets.remerge.io/ad_assets/files/000/006/696/original/banner_300_50.png?1478088208 | |
event.impressions(事件展示) | App、国家/地区、推广、广告级别上的每日展示计数 | 2 | |
event.clicks(事件点击) | App、国家/地区、推广、广告级别上的每日点击计数 | 1 | |
event.app_open_rate(事件 app 打开比率) | 点击打开 App 的百分比 | 83.57 | |
event.cost(事件成本) | App、国家/地区、推广、广告级别上以客户货币计算的成本 | 0.12 | |
event.conversions(事件转化) | App、国家/地区、推广、广告级别上的每日目标转化计数 | 1 | |
event.ap_conversions(事件广告转化) | App、国家/地区、推广、广告级别上的每日归因目标转化计数 | 5 | |
event.unique_user(事件唯一用户) | App、国家/地区、推广、广告级别上的每日唯一用户计数 | 2 |
JSON 响应示例(同一查询的两个显示选项)
选项 1:
选项 2:
如果在给定时间间隔内没有现有数据,则请求返回一个空的结果数组并计数:0
可能出现的错误列表
状态 | 信息 | 说明 |
---|---|---|
200 | OK(确定) | 查询结果以 JSON 形式返回 |
401 | 未获得授权 | 提供的授权令牌无效 |
422 | 起始日期:格式为 YYYY-MM-DD(年-月-日) | 起始日期格式错误 |
422 | 结束日期:格式为 YYYY-MM-DD(年-月-日) | 结束日期格式错误 |
422 | 起始日期:必须为有效日期 | 未提供真实日期,例如,2015-33-09 |
422 | 结束日期:必须为有效日期 | 未提供真实日期,例如,2015-33-09 |
422 | 结束日期:结束日期必须大于或等于起始日期 | 结束日期早于起始日期 |
422 | queryID(查询 ID):queryId 已经存在 | 用户已经发送了一个请求,该请求仍然通过 API 处理。每位用户的查询率限制为 1。 |
504 | 网关超时 | Web 服务器处理该请求的时间过长。这种错误通常是由于查询间隔时间太长造成的。如果出现这种情况,请重新尝试缩短间隔,最长间隔时间为 14 天。 |
索引
* API Timestamp(API 时间戳)- 默认情况下,起始日期和结束日期的设置均为当天零时 00:00。举例来说,这意味着如果您想精确地查询某一天,可以将这一天作为起始日期,将第二天作为结束日期。确保一次只请求一天的数据(例如,每天请求昨天的数据并将其存储在内部数据库中)。
** 务必按推广活动划分您的报告,以防在不同的推广活动中使用了不同的货币。
*** Remerge 使用术语“受众”来指代整个应用(不像在某些语境中,受众指的是受众分群)。提取报告后,Remerge Reporting API(Remerge 报告 API)将返回一个名为 Audience(受众)的字段。这意味着该报告包含了整个 app的静态数据。
对于动态广告,显示的广告 URL 只是一个占位符,因为实际的广告 URL 是从订阅源动态获取的。遗憾的是,它们无法显示在此报告中。