Report API接入文档

2026-02-06

接口鉴权

服务接口鉴权采用Basic Auth方式进行接口的鉴权，开发者的Key与Secret通过在开发者后台来进行获取；在进行基本认证的过程里，请求的请求头Header会包含Authorization字段，形式如下： Authorization: Basic <凭证>，该凭证是用户和密码的组和的base64编码

Authorization: Basic ${base64_string}

上图的base64_string的生成算法为： base64(Key:Secret)

鉴权示例：

例如开发者的Key为字符串 abcdef；开发者的Secret为 123456；则通过base64生成的字符串为 YWJjZGVmOjEyMzQ1Ng==

curl -XPOST -v 'https://ssp-open-api.adprod.cn/xxx'  
-H'Authorization: Basic YWJjZGVmOjEyMzQ1Ng==' 
-H'Content-Type:application/json' -d'{"xxx":"xxx"}'

数据查询

查询广告位收益数据

接口说明：

按照日期查询广告位天维度的收益数据

请求地址：

https://ssp-open-api.adprod.cn/ssp-dev/api/report/adTag/daily/page

请求方法：

POST

内容类型：

application/json

请求参数：

字段	类型	是否必填	描述
startDate	String	Y	统计开始时间，格式yyyy-MM-dd
endDate	String	Y	统计结束时间，格式yyyy-MM-dd(最多查询15天范围)
pageNum	Integer	Y	页码，从1开始
pageSize	Integer	Y	每页条数，最大不得超过200
appId	Long	N	应用id
adTagId	String	N	广告位id
dimension	Integer	N	报表维度：1-广告位维度，2-广告位+包名维度，默认1-广告位维度

请求参数示例：

{
    "adTagId": "xxxx",
    "startDate": "2025-01-01",
    "endDate": "2025-01-07",
    "appId": 100001,
    "pageSize": 1,
    "pageNum": 10,
    "dimension": 1
}

调用示例：

curl -XPOST 'https://ssp-open-api.adprod.cn/ssp-dev/api/report/adTag/daily/page' 
-H'ContentType:application/json'
-H'Authorization: Basic YWJjZGVmOjEyMzQ1Ng=='
-d'{adTagId":"xxxx","startDate":"2025-01-01","endDate":"2025-01-07","appId":100001,"pageSize":1,"pageNum":10}'
-v

应答字段：

字段	类型	描述
code	Integer	返回码
msg	String	返回信息
data	Object	返回结果

data内容

字段	类型	描述
records	List<Object>	对象列表
total	Long	满足条件数据总数
size	Long	每页数据量
current	Long	当前页码
pages	Long	总页数

records内容

字段	类型	描述
id	Long	数据id
deviceOs	Integer	系统，1iOS，2Andriod
appPkgName	String	应用包名
appName	String	应用名称
appId	Long	应用id
adTagId	Long	广告位id
adTagName	String	广告位名称
adType	Integer	广告位类型，1-开屏，2-信息流，3-激励视频，4-插屏，5-横幅，6-沉浸广告
bidType	Integer	竞价方式，1常规非竞价，2头部竞价HB
comp	Long	参竞量
win	Long	竞得量
imp	Long	曝光量
clk	Long	点击量
clkRate	String	点击率
dataDate	String	数据时间
settlementCpm	String	结算cpm
settlementAmount	String	结算金额
dimension	Integer	报表维度：1-广告位维度，2-广告位+包名维度，默认1-广告位维度

应答示例：

{
    "code": 0,
    "msg": "success",
    "data": {
        "records": [
            {
                "id": 7,
                "deviceOs": 2,
                "appPkgName": "com.xxx",
                "appName": "测试应用",
                "adTagId": "3bngbhtywbam",
                "adTagName": "测试广告位",
                "adType": 1,
                "bidType": 1,
                "comp": 31,
                "win": 31,
                "imp": 31,
                "clk": 3,
                "appId": 100006,
                "clkRate": "9.68",
                "dataDate": "2025-05-28",
                "settlementCpm": "1.10",
                "settlementAmount": "1.10",
                "dimension": 1
            }
        ],
        "total": 1,
        "size": 10,
        "current": 1,
        "pages": 1
    }
}

附录

返回码

响应说明：服务调用过程中httpCode统一响应200；参数异常或业务异常统一通过响应体中的code来进行体现

成功响应

code	message
0	success

错误码定义

code	message
1	参数错误
3	系统繁忙
12	账号错误或状态异常