请输入
菜单

高级报表

注意：

接入Api前请先熟悉api签名机制（参考接口鉴权说明）, 即Api请求样例中的一些http请求头的来源

1.请求URL

https://openapi.hyperbid.com/v1/report/full

2.请求方式

POST

3.请求参数

字段 类型 是否必传 备注 样例

time_zone

String

 Y 时区，枚举值：UTC-8、UTC+8、UTC+0  "UTC+8"

start_date

Int

 Y 开始日期，格式：YYYYmmdd 20250801

end_date

Int

 Y 结束日期，格式YYYYmmdd 20250801

app_id_list

Array[String]

 N 开发者后台的多聚合应用ID列表，最大查询100个 ["ja547b671dc3ef29"]

placement_id_list

Array[String]

 N 开发者后台的聚合单元ID列表，最大查询100个  ["kde0e6953d508fee"]

segment_id_list

Array[Int]

 N 开发者后台的流量分组ID列表，最大查询100个 [300000126]

unit_id_list

Array[Int]

 N 开发者后台的广告单元ID列表，最大查询100个 [300000268]

abtest_item_id_list

Array[Int]

 N

开发者后台的A/B测试分组ID列表，最大查询100个

 [300000025]

channel_list

Array[Int]

 N 开发者后台的渠道名称列表，最大查询100个 ["MyChannel"]

geo_short_list

Array[String]

 N 国家短码列表，不传默认所有国家，最大查询100个 ["US","CN"]

nw_firm_id_list

Array[Int]

 N 广告平台ID列表 [1,2]

mm_firm_id_list

Array[Int]

 N 聚合平台ID列表 [1,2]

format_list

Array[Int]

 N 广告样式列表，有效枚举值：
0：原生（Native）
1：激励视频（Rewarded Video）
2：横幅（Banner）
3：插屏（Interstitial）
4：开屏（Splash）		 [0,1,2]

sdk_version_list

Array[String]

 N SDK版本列表，最大查询100个 ["1.0.0"]

app_version_list

Array[String]

 N 应用版本列表，最大查询100个 ["5.0.0"]

platform_list

Array[Int]

 N 系统平台列表，有效枚举值：
1：Android
2：iOS		 [1,2]

idfa_status_list

Array[Int]

 N IDFA状态列表，有效枚举值：
1：有IDFA
0：无IDFA		 [1]

user_type_list

Array[Int]

 N 用户类型列表，有效枚举值：
1：新用户
2：老用户		 [1]

is_ps

Int

 N SDK预置策略，有效枚举值：
1：是
2：否		 2

metric

Array[String]

 N

当同时选了all和其他指标时即返回全部指标： default（默认的一些指标：dau, aipau, engaged_rate, estimated_revenue, estimated_revenue_ecpm, estimated_revenue_arpu, load, load_filled_rate, request, request_filled_rate,

impression, impression_rate, click, ctr），
all（全部指标），
dau（DAU），

dau_launch（启动DAU），

deu（DEU），

engaged_rate（渗透率），

aipau（展示/DAU），

aipu（展示/DEU），

new_user（新用户），new_user_rate（新用户占比），

estimated_revenue（预估收益），

estimated_revenue_arpu（预估ARPDAU），

estimated_revenue_ecpm（预估eCPM），

estimated_revenue_rate（预估收益占比），

bid_total（参与比价），

bid_request_rate（参与比价率），

bid_win_rate（比价胜率），

bid_ecpm（比价eCPM），

bid_win（比价胜出），

load（聚合单元请求），

load_filled_rate（聚合单元填充率），

request（广告单元请求），

request_filled_rate（广告单元填充率），

impression（展示），

impression_rate（展示率），

click（点击），

ctr（点击率），

request_cost_time（填充耗时），

sdk_impression_rate（展示占比）

click_rate（点击占比），

ready_request（查询isReady），

ready_success_rate（isReady成功率），

revenue_gap（收益Gap），

ecpm_gap（eCPM Gap），

impression_gap（展示Gap），

click_gap（点击Gap），

unit_request（请求API），

unit_filled_rate（填充率API），

unit_impression（展示API），

unit_click（点击API），

unit_ctr（点击率API），

unit_click_rate（点击API占比）

unit_impression_rate（展示API占比）

arpu（ARPDAU），

unit_revenue（收益API），

unit_ecpm（eCPM API），

unit_revenue_rate（收益API占比）

 ["dau","deu"]

group_by

Array[String]

 N

筛选维度列表，支持的维度如下：

date_time（日期，默认值），

app_id（应用），

placement_id（聚合单元），

segment_id（流量分组），

unit_id（广告单元），

abtest_item_id（A/B测试分组），

format（广告类型），

nw_firm_id（广告平台），

mm_firm_id（聚合平台），

geo_short（地区），

channel（渠道），

sdk_version（SDK版本），

app_version（应用版本），

idfa（IDFA状态），

platform（系统平台），

user_type（用户类型）

 ["date_time","user_type"]

order_by

Array[Array[String][2]]

 N

指标排序，支持以下指标：

request, impression, click, dau, deu, estimated_revenue, unit_request, unit_impression, unit_click, unit_revenue, load, new_user, dau_launch, request_filled_rate, load_filled_rate, ctr, ecpm, new_user_rate, arpu, engaged_rate, aipu, aipau, unit_filled_rate, impression_rate, unit_ctr, unit_ecpm, unit_ecpr, impression_gap, click_gap, estimated_revenue_ecpm, ready_success_rate, estimated_revenue_arpu, revenue_gap, ecpm_gap, request_cost_time, bid_request_rate, bid_total, impression_rate, bid_ecpm, bid_win, unit_revenue_rate, unit_impression_rate, unit_click_rate, sdk_impression_rate, click_rate, estimated_revenue_rate, ready_request

支持排序方式：

asc（顺序）

desc（倒序）

 [["dau","desc"]]
start Int N 偏移数，代表从第几条数据开始，默认为0 0
limit Int N 每次拉取数据的最大条数，默认是1000，最大1000，可选[1,1000] 10

4.返回参数

字段 类型 是否必传 备注
records Array[Object] Y 记录，对象数组每个record结构见下面records元素结构
count Int Y 总条数
time_zone String Y 时区，枚举值：UTC-8、UTC+8、UTC+0
currency String Y 开发者账号币种

records元素结构：

字段 类型 是否必传 备注
date_time String N 日期，格式：YYYYmmdd。group_by有选date_time才有返回
app_id String N 开发者后台的应用ID，group_by有选app维度时才返回
placement_id String N 开发者后台的聚合单元ID，group_by有选placement_id维度时才返回
segment_id Int N 开发者后台的流量分组ID，group_by有选segment_id维度时才返回
unit_id Int N 开发者后台的广告单元ID，group_by有选unit_id维度时才返回
abtest_item_id Int N 开发者后台的A/B测试分组ID，group_by有选abtest_item_id维度时才返回
format Int N 广告样式，group_by有选format维度时才返回，有效枚举值：
0：原生（Native）
1：激励视频（Rewarded Video）
2：横幅（Banner）
3：插屏（Interstitial）
4：开屏（Splash）
geo_short String N 国家短码，group_by有选geo_short维度时才有返回
mm_firm_id Int N 开发者后台的聚合平台ID，group_by有选mm_firm_id维度时才返回
nw_firm_id Int N 开发者后台的广告平台ID，group_by有选nw_firm_id维度时才返回
platform Int N 系统平台类型，group_by有选platform维度时才返回，有效枚举值：
1：Android
2：iOS
sdk_version String N SDK版本，group_by有选sdk_version维度时才返回
app_version String N 应用版本，group_by有选app_version维度时才返回
channel String N 渠道，group_by有选channel维度时才返回
idfa_status Int N IDFA状态，group_by有选idfa维度时才返回，有效枚举值：
1：有IDFA
0：无IDFA
user_type Int N 用户类型，group_by有选user_type维度时才返回，有效枚举值：
1：新用户
2：老用户
dau Int N DAU，注意：当选了某些group_by维度(例如：is_ps)，响应不返回DAU相关指标
dau_launch Int N 启动DAU，注意：当选了某些group_by维度(例如：segment_id、unit_id、nw_firm_id、format、sdk_version、app_version)，响应不返回该指标
deu Int N DEU，注意：当选了某些group_by维度(例如：is_ps)，响应不返回DEU相关指标
engaged_rate Float N 渗透率
aipau Float N 展示/DAU
aipu Float N 展示/DEU
new_user Int N 新用户，注意：当选了某些group_by维度(例如：segment_id、unit_id、nw_firm_id、format、sdk_version、app_version、idfa)，响应不返回新用户指标
new_user_rate Float N 新用户占比
estimated_revenue Float N 预估收益，按开发者账号币种返回的预估收益
estimated_revenue_arpu Float N 预估ARPDAU，有DAU才有该项返回，单位：按开发者账号币种
estimated_revenue_ecpm Float N 预估eCPM
estimated_revenue_rate Float N 预估收益占比
bid_total Int N 参与比价，注意：当选了某些group_by维度(例如：nw_firm_id)，响应不返回该指标
bid_request_rate Float N 参与比价率，注意：当选了某些group_by维度(例如：nw_firm_id)，响应不返回该指标
bid_win_rate Float N 比价胜率，注意：当选了某些group_by维度(例如：placement_id、unit_id)，响应返回该指标
bid_ecpm Float N 比价eCPM
bid_win Int N 比价胜出次数
load Int N 聚合单元请求，注意：当选了某些group_by维度(例如：unit_id、nw_firm_id、mm_firm_id)，响应不返回该指标
load_filled_rate Float N 聚合单元填充率，注意：当选了某些group_by维度(例如：unit_id、nw_firm_id、mm_firm_id)，响应不返回该指标
request Int N 广告单元请求，注意：当选了某些group_by维度(例如：nw_firm_id)，响应不返回该指标
request_filled_rate Float N 广告单元填充率，注意：当选了某些group_by维度(例如：nw_firm_id)，响应不返回该指标
impression Int N 展示
impression_rate Float N 展示率
click Int N 点击
ctr Float N 点击率
request_cost_time Int N 填充耗时，单位毫秒
click_rate Float N 点击占比，计算公式=展示/汇总展示
sdk_impression_rate Float N 展示占比，计算公式=展示/汇总展示
ready_request Int N 查询isReady，注意：当选了某些group_by维度(例如：unit_id、nw_firm_id、mm_firm_id)，响应不返回isReady指标
ready_success_rate Float N isReady成功率
revenue_gap Float N 收益Gap，注意：当选了某些group_by维度(例如：segment_id、channel、sdk_version、app_version、user_type、idfa、is_ps)，响应不返回Gap指标
ecpm_gap Float N eCPM Gap
impression_gap Float N 展示Gap
click_gap Float N 点击Gap
unit_request Int N

请求API，注意：当选了某些group_by维度(例如：segment_id、sdk_version、app_version、channel、idfa、user_type、is_ps)，响应不返回API指标

nw_firm_id维度也不返回该指标
unit_filled_rate Float N 填充率API，注意：当选了某些group_by维度(例如：nw_firm_id)，响应不返回该指标
unit_impression Int N 展示API
unit_click Int N 点击API
unit_ctr Float N 点击率API
unit_click_rate Float N 点击API占比
unit_impression_rate Float N 展示API占比
arpu Float N ARPDAU，注意：当选了某些group_by维度(例如：nw_firm_id)，响应不返回该指标
unit_revenue Float N 收益API
unit_ecpm Float N eCPM API
unit_revenue_rate Float N 收益API占比

5.样例

请求样例：

curl --location --request POST 'https://openapi.hyperbid.com/v3/report/full' \
--header 'X-Up-Key: a5c20012d6964913dcea19dbb09243282518505c' \
--header 'X-Up-Signature: CE12B506DBCD868C2C6F09E08C139CBC' \
--header 'X-Up-Timestamp: 1754033553000' \
--header 'Content-Type: application/json' \
--data-raw '{
    "start_date": 20250801,
    "end_date": 20250801,
    "group_by":["date_time"],
    "start": 0,
    "limit": 30,
    "time_zone": "UTC+8",
    "app_id_list":["ja547b671dc3ef29"]
}'

返回样例：

{
    "count": 1,
    "time_zone": "UTC+8",
    "currency": "USD",
    "records": [
        {
            "date_time": 20250801,
            "dau": 279,
            "aipau": 1.2043,
            "engaged_rate": 0.301,
            "estimated_revenue": 0.608784,
            "estimated_revenue_ecpm": 1.81,
            "estimated_revenue_arpu": 0.0021,
            "load": 1817,
            "load_filled_rate": 0.3307,
            "request": 4529,
            "request_filled_rate": 0.2525,
            "impression": 336,
            "click": 53,
            "ctr": 0.1577
        }
    ]
}
上一个
数据报表API
下一个
Ltv报表（1-90天数据）
最近修改: 2025-08-19Powered by