菜单

Adx上游白盒报表

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

1 请求URL

https://openapi.toponad.com/v3/report/adx_white

2 请求方式

POST

3 请求参数

字段	类型	是否必传	备注	样例
start_date	Int	Y	起始日期，格式：YYYYmmdd	20190501
start_date	Int	Y	起始日期，格式：YYYYmmdd	20190501
currency	String	Y	币种，指标revenue，ecpm等使用的币种可选：USD，CNY
time_zone	String	Y	时区，枚举值：UTC-8、UTC+8、UTC+0
app_id_list	Array[String]	N	应用ID列表	[“a600e6fbeac98c”]，
placement_id_list	Array[String]	N	广告位ID列表
scenario_list	Array[String]	N	广告场景列表，"1" 代表默认场景
adformat_list	Array[Int]	N	广告位样式列表，有效枚举值说明： 0：原生（Native） 1：激励视频（Rewarded Video） 2：横幅（Banner） 3：插屏（Interstitial） 4：开屏（Splash）
segment_id_list	Array[Int]	N	流量分组ID列表，0代表默认分组
geo_short_list	Array[String]	N	国家短码列表	[“US”,"CN"]
sdk_version_list	Array[String]	N	sdk版本列表	["5.0.0"]
app_version_list	Array[String]	N	app版本列表	["5.0.0"]
dsp_id_list	Array[String]	N	上游id列表
start	Int	N	偏移数，代表从第几条数据开始，默认为0	0
limit	Int	N	每次拉取数据的最大条数，默认是1000，最大1000，可选[1,1000]
group_by	Array[String]	N	group by 维度，不传时默认date维度，支持的维度说明: date（日期）， app_id（应用ID）， placement_id（广告位ID）， scenario（广告场景）， adformat（广告位样式）， segment_id（流量分组ID）， geo_short（国家短码）， sdk_version（sdk版本）， app_version（app版本）， dsp_id（上游id），	["placement_id"]

4 响应参数

字段	类型	是否必传	备注
records	Array[Object]	N	记录，对象数组每个record结构见下面records元素结构，无数据时为空
count	Int	N	总条数，无数据时为空

records元素结构如下：

字段名	类型	是否必传	备注
date	Int	N	日期，格式：YYYYmmdd
revenue	Double	Y	三方广告平台的收益，币种为请求参数的currency
request	Int	Y	TopOn统计的请求数。注意：广告位+流量分组维度的一次请求可能会对应多个广告源维度的请求，取决于并行请求数设置和每层广告源的填充情况
request_fill_rate	Float	Y	填充率
impression	Int	Y	展示
impression_rate	Float	Y	展示率
click	Int	Y	点击
click_rate	Float	Y	点击率
ecpm	Float	Y	ecpm，注意：0时不返回
adx_request	Int	N	ADX询价次数，0时不返回注意：group_by维度有选dsp_id，或者dsp_id_list有传值时不返回
adx_response_rate	Float	N	ADX询价响应率，0时不返回注意：group_by维度有选dsp_id，或者dsp_id_list有传值时不返回
cpc	Float	Y	CPC
dsp_request	Int	Y	上游询价次数
dsp_response_rate	Float	Y	上游询价响应率
dsp_win	Int	Y	上游胜出次数
app_id	String	N	应用ID，group_by维度有选app_id才返回
placement_id	String	N	广告位ID，group_by维度有选placement_id才返回
segment_id	Int	N	流量分组ID，group_by维度有选segment_id才返回，0代表默认分组
scenario	String	N	广告场景ID，group_by维度有选scenario才返回，"1" 代表默认场景
adformat	Int	N	广告样式，group_by维度有选adformat才返回，有效枚举值说明： 0：原生（Native） 1：激励视频（Rewarded Video） 2：横幅（Banner） 3：插屏（Interstitial） 4：开屏（Splash）
sdk_version	String	N	sdk版本，group_by维度有选sdk_version才返回
app_version	String	N	app版本，group_by维度有选app_version才返回
geo_short	Int	N	国家2字符短码，group_by维度有选geo_short才返回
dsp_id	Int	N	上游ID，group_by维度有选dsp_id才返回

5 样例

请求样例：

curl --location --request POST 'https://openapi.toponad.com/v3/report/creative_review' \
--header 'X-Up-Key: 877f8ae9c6e9ca82c0==5b5fff594c373axxx' \
--header 'X-Up-Signature: CE12B506DBCD868C2C6F09E08C139CBC' \
--header 'X-Up-Timestamp: 1626161553000' \
--header 'Content-Type: application/json' \
--data-raw '{
    "currency": "CNY",
    "start_date": 20241007,
    "end_date": 20241007,
    "placement_id_list": [],
    "start": 0,
    "group_by": ["dsp_id"],
    "time_zone": "UTC+8"
}'

返回样例：

{
    "count": 3,
    "data": [
        {
            "revenue": 134766.4311614208,
            "request": 11443476,
            "request_fill_rate": 0.9831,
            "impression": 4480000,
            "impression_rate": 0.3981,
            "ecpm": 30.0818,
            "adx_request": 12374860,
            "adx_response_rate": 0.9741,
            "dsp_request": 13833855,
            "dsp_response_rate": 0.9741,
            "dsp_win": 12054718,
            "click": 940780,
            "click_rate": 0.2099,
            "cpc": 0.1432,
            "dsp_id": 241
        }
    ]
}

最近修改: 2025-08-06Powered by

大纲