Chartboost API — 数据查询 API

 
广告活动数据分析 API 提供详细报告，可以按应用或素材分组。注意，指定 groupBy 字段后，数据查询队列系统会返回 jobID，在“开始之前” 栏目有详细描述。  
HTTP 方法 GET
端点 https://analytics.chartboost.com/v3/metrics/campaign
示例请求 https://analytics.chartboost.com/v3/metrics/campaign?dateMin={{Minimum date}}&dateMax={{Maximum date}}&userId={{Chartboost customer’s user ID}}&userSignature={{CB customer’s user signature}}
 
参数
参数 请求类型 是否必填? 描述 默认
合计 字符串 可选 按时间累计结果 (每日、每周、每月) 每日
campaignId 字符串 可选 广告活动 ID (既可以是 To Campaign ID 又可以是 From Campaign ID 基于 groupBy 和角色) 不适用
campaignType 字符串 可选 network, cross_promo network
dateMin 字符串 必填 最小日期 (YYYY-MM-DD) 不适用
dateMax 字符串 必填 最大日期 (YYYY-MM-DD) 不适用
groupBy 字符串 可选 以下其中一项: 'country' 'app' 'app,creative' 'target_creative' 'date' 'campaign' 'campaign_target' 'campaign_type' 无
platform 字符串 可选 按指定平台筛选结果 (iOS、Google Play、Amazon) 全部
角色 字符串 可选 广告主或流量主 全选
 
回复字段
参数 描述 返回用作…
adTypeId 1 = interstitial 2 = more_apps 3 = in_play 4 = rewarded_video 5 = video_interstitial 10 = banner 所有人
应用 应用名称 所有人
广告活动 广告活动名称 所有人
campaignId 广告活动 ID (既可以是 To Campaign ID 又可以是 From Campaign ID 基于 groupBy 和角色) 所有人
campaignTarget 广告定位名称 (仅在按 campaign_target 分组时返回) 广告主
campaignSubType user_acquisition 所有人
clicksDelivered 传递点击数 流量主
clicksReceived 接收点击数 广告主
cpcvEarned 完成视频收益与查看数比率 流量主
cpcvSpent 完成视频成本与查看数比率 广告主
广告图片 广告素材名称 (仅在按 creative 分组时返回) 广告主
ctrDelivered 已传递展示次数的点击率 流量主
ctrReceived 已接收展示次数的点击率 广告主
dt 日期 (YYYY-MM-DD) 所有人
ecpmEarned 每 1,000 次展示收益 流量主
ecpmSpent 每 1,000 次展示成本 广告主
impressionsDelivered 流量主传递展示次数 流量主
impressionsReceived 广告主接收展示次数 广告主
installDelivered 传递安装数 流量主
installRateDelivered 安装率 流量主
installRateReceived 安装率 广告主
installReceived 安装 广告主
moneyEarned 收益金额 流量主
moneySpent 花费金额 广告主
videoCompletedDelivered 传递的视频查看完毕次数 流量主
videoCompletedReceived 接收的视频查看完毕次数 广告主
  ▲ 返回顶部
应用数据分析端点提供详细报告，可以按应用、广告类型或广告位置。  
HTTP 方法 GET
API https://analytics.chartboost.com/v3/metrics/app
示例请求 https://analytics.chartboost.com/v3/metrics/app?dateMin={{Minimum date}}&dateMax={{Maximum date}}&userId={{Chartboost customer’s user ID}}&userSignature={{CB customer’s user signature}}
 
参数
参数 请求类型 是否必填? 描述 默认
合计 字符串 可选 按时间累计结果 (每日、每周、每月) 每日
appId 字符串 可选 一个或多个 (逗号分隔) 应用 ID 全部
dateMax 字符串 必填 最大日期 (YYYY-MM-DD) 不适用
dateMin 字符串 必填 最小日期 (YYYY-MM-DD) 不适用
groupBy 字符串 可选 以下其中一项: app, ad_type,app, date, ad_location (仅限流量主), platform, campaign_type 无
platform 字符串 可选 以下任何: iOS, Google Play, 亚马逊 全部
角色 字符串 可选 广告主或流量主 全选
 
回复字段
参数 描述 返回用作…
ad_type 广告素材类型 了解广告类型详情 ▶ 所有人，仅当 groupBy=ad_type,app
allInstalls 不计来源累计安装总数 (Chartboost 或其他) 所有人
应用 应用名称 所有人
appBundleId 不再发送；用户会在报告中看到弃用 所有人
appId Chartboost 应用 ID 所有人
启动数 用户在设备上启动您的应用的次数 所有人
campaignType network, cross_promo 所有人, 仅当 groupBy=campaignType
clicksDelivered 传递点击数 流量主
clicksReceived 接收点击数 广告主
cpcvEarned 完成视频收益与查看数比率 流量主
cpcvSpent 完成视频成本与查看数比率 广告主
ctrDelivered 已传递展示次数的点击率 流量主
ctrReceived 已接收展示次数的点击率 广告主
dt 日期 (YYYY-MM-DD) 所有人
ecpmEarned 每 1,000 次展示收益 流量主
ecpmSpent 每 1,000 次展示成本 广告主
eventLocation Chartboost 命名位置。广告主会在相应字段看到Default。 所有人
impressionsDelivered 流量主传递展示次数 流量主
impressionsReceived 广告主接收展示次数 广告主
installDelivered 传递安装数 流量主
installRateDelivered 安装率 流量主
installRateReceived 安装率 广告主
installReceived 安装 广告主
moneyEarned 收益金额 流量主
moneySpent 花费金额 广告主
platform iOS, Google Play 或 Amazon 所有人
唯一数 启动过此应用的唯一设备数 所有人
videoCompletedDelivered 传递的视频查看完毕次数 流量主
videoCompletedReceived 接收的视频查看完毕次数 广告主
  ▲ 返回顶部
导出安装数端点提供所有接收或提供安装数的完整列表。断点会一直从列队数据分析系统返回工作 ID，在“开始之前”栏中有详细说明。  
HTTP 方法 GET
API https://analytics.chartboost.com/v3/metrics/install
示例请求 https://analytics.chartboost.com/v3/metrics/install?dateMin={{Minimum date}}&dateMax={{Maximum date}}&userId={{Chartboost customer’s user ID}}&userSignature={{CB customer’s user signature}}
 
参数
参数 请求类型 是否必填? 描述 默认
campaignIds 字符串 可选 一个或多个 (逗号分隔) 广告活动 ID 所有广告活动
campaignType 字符串 可选 network, cross_promo 全部
dateMax 字符串 必填 最大日期 (YYYY-MM-DD) 不适用
dateMin 字符串 必填 最小日期 (YYYY-MM-DD) 不适用
platform 字符串 可选 以下任何: iOS, Google Play, Amazon 全部
角色 字符串 可选 广告主或流量主 全选
 
回复字段
参数 描述 返回用作…
广告类型 广告素材类型 了解广告类型详情 ▶ 所有人
点击时间戳 日期和时间 (DD-MM-YYYY HH:MM:SS) 所有人
费用类型 广告竞价类型 了解竞价类型详情 ▶ 所有人
费用值 广告投标数量 所有人
国家 设备双字符国家代码 所有人
日期 日期和时间 (DD-MM-YYYY HH:MM:SS) 所有人
来自应用文件包 发布应用文件包 ID 所有人
从应用 ID 发布应用 ID 所有人
从应用名称 发布应用名称 所有人
来自广告活动 ID 发布活动 ID 流量主
来自广告活动名称 发布活动名称 流量主
来自广告活动类型 network, cross_promo 流量主
GAID Google 广告 ID 所有人 (如果行为定位禁用则仅限流量主)
IFA iOS 广告主标识符 (如果 iOS 10 限制广告跟踪已禁用) 所有人 (如果行为定位禁用则仅限流量主)
MAC MAC 地址 (弃用) 不适用
类型 设备型号 所有人
OS 设备操作系统 所有人
到应用文件包 广告应用文件包 ID 所有人
到应用 ID 广告应用 ID 所有人
到应用名称 广告应用名称 所有人
到广告活动 ID 广告活动 ID 广告主
到广告活动名称 广告活动名称 广告主
到广告活动定位 广告活动定位 ID 所有人
到广告活动类型 network, cross_promo 广告主
UUID 设备通用唯一标识符 (如可用) 所有人 (如果行为定位禁用则仅限流量主)
  ▲ 返回顶部
除了您在后台的 API 浏览器页面发现的端点外，我们专门设计了用于在应用、日期和国家层面输出数据分析的端点。此端点还可由需要国家层面数据的第三方归属和中介服务代表 Chartboost 客户使用。
应用数据分析按国家分组 API 仅提供过去 40 天的数据查询。
中介网络说明: 强烈建议您忽略广告活动类型字段，因为 API 会自动为 network 返回结果。
“更多应用”数据未包括在此 API 中。注意，应用和广告活动端点和您的后台数据分析可能有出入。使用广告活动端点并按照国家分组以获取应用, 国家, 和 ad_type 数据。
 
API 返回的数据一般会有几个小时的延迟。默认以 UTC 时区为基准。
所有 adLocation 为空 "" 的记录会被聚合到 Default 这个命名空间下.
HTTP 方法 GET
API https://analytics.chartboost.com/v3/metrics/appcountry
示例请求 https://analytics.chartboost.com/v3/metrics/appcountry?dateMin={{Minimum date}}&dateMax={{Maximum date}}&userId={{Chartboost customer’s user ID}}&userSignature={{CB customer’s user signature}}
 
参数
参数 请求类型 是否必填? 描述 默认
appIds 字符串 可选 一个或多个 (逗号分隔) 应用 ID 全部应用
dateMin 字符串 必填 最小日期 (YYYY-MM-DD) 不适用
dateMax 字符串 必填 最大日期 (YYYY-MM-DD) 不适用
campaignType 字符串 可选 network, cross_promo 或者全部 network
adTypeIds 字符串 可选 一个或多个 (逗号分隔) 广告类型 ID: 1 = interstitial, 3 = in_play, 4 = rewarded_video, 5 = video_interstitial 1,4,5
角色 字符串 可选 广告主或流量主 流量主
时区 字符串 可选 utc 或 pst utc
adLocation 字符串 可选 一个或多个 (逗号分隔) adLocations
  • 实例 #1: (adLocation=<value which is not 'all'>) 仅针对该 adLocation 并按照指定 adLocation 汇总显示结果。仅当 adLocation 为发布应用的前 3 项 adLocation 时才提供该信息。其他 adLocation 无返回信息。
  • 实例 #2: (adLocation='all') 对于发布应用显示前 3 项 adLocation 的分项结果，其他结果汇总为 adLocation = 'other'。
  • 实例 #3: (adLocation= 空置或未传入) 汇总所有 adLocation = 'overall' 下的数据。不提供按照 adLocation 细分的信息。
 查看实例 #3
adLocation 命名空间的值必须是最近活跃的（譬如被多次请求并展示）。否则它们可能被聚合到 Default 命名空间下。
 
回复字段
参数 描述 返回用作…
adLocation Chartboost 命名位置。广告主会在相应字段看到Default。 所有人
adType interstitial, rewarded_video, video_interstitial 所有人
应用 应用名称 所有人
campaignType 网络、交叉推广 所有人
clicksDelivered 点击 流量主
clicksReceived 点击 广告主
countryCode 双字母国家代码或 “Unknown” 所有人
cpcvEarned 完成视频收益与查看数比率 流量主
cpcvSpent 完成视频成本与查看数比率 广告主
ctrDelivered 点击率 流量主
ctrReceived 点击率 广告主
dt 日期 (YYYY-MM-DD) 所有人
ecpmEarned 每 1000 次展示收益 流量主
ecpmSpent 每 1000 次展示成本 广告主
impressionsDelivered 展示次数 流量主
impressionsReceived 展示次数 广告主
installRateDelivered 安装率 流量主
installRateReceived 安装率 广告主
installsDelivered 安装 流量主
installsReceived 安装 广告主
moneyEarned 收益金额 流量主
moneySpent 花费金额 广告主
platform iOS, Google Play 或 Amazon 所有人
videoCompletedDelivered 已完成视频查看 流量主
videoCompletedReceived 已完成视频查看 广告主
  ▲ 返回顶部
您可能还希望…
 

Last Updated on 6月 9, 2021