数据报表查询 API | TradPlus Knowledge Center

修订历史

发布时间	修订说明
2023-11-22	新增V4接口，支持Mintegral平台广告位返回增加 AD Unit ID
2023-02-27	综合报表新增埋点收入指标eventRevenue
2023-02-06	综合报表新增维度：应用版本，渠道，SDK版本，IDFA授权，A/B测试分组
2023-01-04	用户LTV新增维度：广告位，应用版本，渠道用户留存新增维度：应用版本，渠道
2022-12-16	综合报表新增应用请求指标appRequest
2022-10-10	综合报表所有维度支持TradPlus统计数据、新增广告网络竞价指标
2022-02-09	综合报表新增广告场景维度查询
-	支持用户留存、用户价值数据查询
-	支持综合报表数据查询

注意事项

各类指标数据说明

https://docs.tradplusad.com/docs/operation/tradplus_qa/report/#tradplus报表中的各项指标分别是什么意思？

各类指标数据更新时间

https://docs.tradplusad.com/docs/operation/tradplus_qa/report/#各类数据的更新时间是什么？

1. 接口校验

1.1 协议

HTTP

1.2 Header公共请求参数

需要在头部加入 Authorization: Bearer {your token}

参数	说明	样例
Authorization	authorization info	Bearer {your token}

curl --location --request POST 'https://openapi.tradplusad.com/v3/allreport' \
--header 'Authorization: Bearer BB86G020-ED1C-E02A-637E-BA73D9A4FF01' \
--header 'Content-Type: application/json' \
--data-raw '{
    "startDate": "2022-09-27",
    "endDate": "2022-09-27",
    "timezone": "UTC+0",
    "currency": "USD",
    "groupBy":
    [
        "date"
    ],
    "metric":
    [
        "all"
    ]
}'

token 的获取：后台“我的账号”-“报表API key”-点击生成key

2. 综合报表数据查询 API

2.1 URL

https://openapi.tradplusad.com/v3/allreport

2.2 请求协议

HTTP POST HTTP Content-Type: application/json

2.3请求参数

数据需要拉取到没有返回为止，通过start参数

参数名	类型	是否必传	备注	样例
startDate	String	Y	开始日期，格式：YYYY-mm-dd	2020-03-01
endDate	String	Y	结束日期，格式：YYYY-mm-dd	2020-03-02
timezone	String	N	时区，枚举值，仅支持："UTC+8"、"UTC+0"、"UTC-8"。不传默认为"UTC+0"	UTC+8
currency	String	N	币种：不传默认USD 仅支持USD CNY	USD
bidType	int	N	竞价类型：不传默认所有，1 常规类型 2 竞价类型	0
appIdList	String[]	N	开发者后台的应用ID列表，不传默认为当前账号下所有app
start	Int	N	偏移量，表示从第几条数据开始，默认为0	0
limit	Int	N	每次拉取数据的最大条数，默认是1000，可选[1,20000]之间的任意整数	100
groupBy	String[]	N	date（日期，默认值）, appId（应用）, placementId（广告位）, adFormat（广告类型）, area(ISO 3166-1二位国家地区代码), network（广告网络）, networkPlacementId（三方广告网络的广告位）, adSceneId（广告场景，`三方广告网络不支持此维度，选择后不会返回三方广告网络统计数据`）, sdk (sdk版本，`三方广告网络不支持此维度，选择后不会返回三方广告网络统计数据`) , channel (渠道，`三方广告网络不支持此维度，选择后不会返回三方广告网络统计数据`) , appVersion (应用版本，`三方广告网络不支持此维度，选择后不会返回三方广告网络统计数据`) , idfa (IDFA授权，`三方广告网络不支持此维度，选择后不会返回三方广告网络统计数据`) , bucketId (A/B测试分组，`三方广告网络不支持此维度，选择后不会返回三方广告网络统计数据`)	["network",”networkPlacementId"]
metric	String[]	N	all（所有指标，默认值）, dau（TradPlus统计的日活跃用户数量(app级别)）, deu（TradPlus统计的每日观看广告用户数）, arpu（TradPlus统计的用户平均收入）, newUsers（TradPlus统计的新增用户(app级别)）, requestApi（三方广告网络的请求数）, fillApi（三方广告网络的填充数）, fillrateApi（三方广告网络的填充率）, impressionApi（三方广告网络的展示数）, clickApi（三方广告网络的点击数）, ecpmApi（三方广告网络的ECPM）, ctrApi（三方广告网络的点击率）, revenue（三方广告网络的收入）, bidRequestApi（三方广告网络的竞价请求数）, bidResponseApi（三方广告网络的竞价响应数）, bidResponseRateApi（三方广告网络的竞价响应率）, bidWinRateApi（三方广告网络的竞价胜出率）, appRequest（TradPlus统计的应用请求数）, enterAdScene（TradPlus统计的进入广告场景数）, enterAdSceneUsers（TradPlus统计的进入广告场景用户数）, request（TradPlus统计的请求数）, bidRequest（TradPlus统计的竞价请求数）, bidResponse（TradPlus统计的竞价响应数）, bidResponseRate（TradPlus统计的竞价响应率）, bidWinRate（TradPlus统计的竞价胜出率）, impression（TradPlus统计的展示数）, fill（TradPlus统计的填充数）, click（TradPlus统计的点击数）, clickUsers（TradPlus统计的点击用户数）, ctr（TradPlus统计的点击率）, estimateRevenue（TradPlus统计的埋点展示占比预估收入）, eventRevenue(TradPlus统计的埋点收入)， sdk (TradPlus记录的sdk版本) , channel (TradPlus记录的渠道) , appVersion (TradPlus记录的应用版本) , idfa (TradPlus记录的IDFA授权) , bucketName (TradPlus记录的A/B测试组名称) , countryName (TradPlus记录的国家)	["dau","request","fillrateApi"]

2.4 返回参数

HTTP Content-Type: application/json

字段	类型	备注
code	Int	状态码详见下方状态码定义列表
total	Int	总数据量
timezone	String	时区
message	String	提示信息
items	Array	记录

items元素结构如下：

字段	类型	是否必传	备注
date	String	N	日期，格式：YYYY-mm-dd
appId	String	N	应用ID，`groupBy`有`appId`维度才有返回
platform	Int	N	应用的系统平台 (1 Android, 2 iOS)，`groupBy`有`appId`维度才有返回
packageName	String	N	应用的包名，`groupBy`有`appId`维度才有返回
placementId	String	N	广告位ID，`groupBy`有`placementId`维度才有返回
placementName	String	N	广告位名字，`groupBy`有`placementId`维度才有返回
adFormat	Int	N	广告位类型，`groupBy`有`adFormat`维度才有返回
adFormatName	String	N	广告位类型名字，`groupBy`有`adFormat`维度才有返回
area	String	N	国家地区编码(ISO 3166-1二位国家地区代码)，`groupBy`有`area`维度才有返回
network	Int	N	广告网络ID，`groupBy`有`network`维度才有返回
networkName	String	N	广告网络名字，`groupBy`有`network`维度才有返回
networkPlacementId	String	N	广告网络的广告位ID信息，`groupBy`有`networkPlacementId`维度才有返回
networkPlacementName	String	N	广告网络的广告源名称，`groupBy`有`networkPlacementId`维度才有返回
networkPlacementInfo	String	N	广告网络的广告位详细信息，`groupBy`有`networkPlacementId`维度才有返回
adSceneId	String	N	广告场景ID，`groupBy`有`adSceneId`维度才有返回
adSceneName	String	N	广告场景名称，`groupBy`有`adSceneId`维度才有返回
dau	Int	N	TradPlus统计的日活跃用户数量(app级别)
deu	Int	N	TradPlus统计的每日观看广告用户数
arpu	Float	N	TradPlus统计的用户平均收入
newUsers	Int	N	TradPlus统计的新增用户(app级别)
newUserRate	Float	N	TradPlus统计的新增用户占比(app级别)
bidRequestApi	Int	N	三方广告网络的竞价请求数
bidResponseApi	Int	N	三方广告网络的竞价响应数
bidResponseRateApi	Float	N	三方广告网络的竞价响应率
bidWinRateApi	Float	N	三方广告网络的竞价胜出率
requestApi	Int	N	三方广告网络的请求数
fillApi	Int	N	三方广告网络的填充数
fillrateApi	Float	N	三方广告网络的填充率
impressionApi	Int	N	三方广告网络的展示数
clickApi	Int	N	三方广告网络的点击数
ctrApi	Float	N	三方广告网络的点击率
ecpmApi	Float	N	三方广告网络的ECPM
Revenue	Float	N	三方广告网络的收益
appRequest	Int	N	TradPlus统计的应用请求数
enterAdScene	Int	N	TradPlus统计的进入广告场景次数
enterAdSceneUsers	Int	N	TradPlus统计的进入广告场景用户数
bidRequest	Int	N	TradPlus统计的竞价请求数
bidResponse	Int	N	TradPlus统计的竞价响应数
bidResponseRate	Float	N	TradPlus统计的竞价响应率
bidWinRate	Float	N	TradPlus统计的竞价胜出率
request	Int	N	TradPlus统计的请求数
fill	Int	N	TradPlus统计的填充数
fillrate	Float	N	TradPlus统计的填充率
impression	Int	N	TradPlus统计的展示次数
impressionRatio	Float	N	TradPlus统计的展示占比
click	Int	N	TradPlus统计的点击次数
clickUsers	Int	N	TradPlus统计的点击用户数
ctr	Float	N	TradPlus统计的点击率
estimateRevenue	Float	N	TradPlus统计的预估收益
idfa	Int	N	IDFA授权
bucketName	String	N	A/B测试组名称
countryName	String	N	国家
channel	String	N	渠道
sdk	String	N	sdk版本
appVersion	String	N	应用版本
eventRevenue	Float	N	TradPlus统计的埋点收入

各时区完整数据更新时间点： UTC+0 20(北京时间) UTC+8 21点(北京时间) UTC-8 次日2点(北京时间)

三方广告网络时区说明

2.5 样例

请求样例

{
    "startDate": "2021-07-01",
    "endDate"  : "2021-07-07",
    "timezone" : "UTC+8",
    "currency" : "USD",
    "start": 0,
    "limit": 1000,
    "groupBy":
    [
        "date",
        "appId",
        "placementId"
    ],
    "metric":
    [
        "all"
    ]
}

响应样例

{
    "items": [
        {
            "date": "2021-07-01",
            "appId": "6640E7E3BDAC951B8F28D4C8C50E50B5",
            "packageName": "com.unstall.meetdelete",
            "placementId": "B514A432CE5E96A44BD2E313AC3323AB",
            "placementName": "Banner_1",
            "adFormat": 0,              //groupBy有adFormat维度才有返回
            "adFormatName": "",         //groupBy有adFormat维度才有返回
            "area": "YE",               //groupBy有area维度才有返回
            "network": 0,               //groupBy有network维度才有返回
            "networkName": "",          //groupBy有network维度才有返回
            "networkPlacementName": "", //groupBy有networkPlacementId维度才有返回
            "networkPlacementId": "",   //groupBy有networkPlacementId维度才有返回
            "networkPlacementInfo": "", //groupBy有networkPlacementId维度才有返回
            "adSceneId":"",             //groupBy有adSceneId维度才有返回
            "adSceneName":"",           //groupBy有adSceneId维度才有返回
            "requestApi": 19433,
            "fillApi":150,
            "fillrateApi": 0.13,
            "impressionApi": 1989,
            "clickApi": 236,
            "ecpmApi": 2.21,
            "ctrApi": 0.14,
            "Revenue": 6.59,
            "dau": 679,
            "deu": 223,
            "arpu": 0.01,
            "newUsers": 349,
            "newUserRate": 0.63,
            "enterAdScene":4123,
            "enterAdSceneUsers":3178,
            "impression": 44106,
            "impressionRatio": 0.8507,
            "click": 20358,
            "clickUsers": 16829,
            "ctr": 0.4616,
            "estimateRevenue": 5.31,
            "request": 19432,
            "bidRequestApi": 8655,
            "bidRequest": 9152,
            "bidResponseApi": 4582,
            "bidResponse": 5625,
            "bidResponseRateApi": 0.5294,
            "bidResponseRate": 0.6175,
            "bidWinRateApi": 3.4547,
            "bidWinRate": 4.2409,
			"appRequest": 1549732,
            "idfa": 0,
            "bucketName": "",
            "countryName": "",
            "channel": "",
            "sdk": "",
            "appVersion": ""
        }
    ],
    "timezone": "UTC+8"
}

3. 综合报表数据查询 API v4

3.1 URL_v4

https://openapi.tradplusad.com/v4/allreport

3.2 请求协议_v4

HTTP POST HTTP Content-Type: application/json

3.3请求参数_v4

数据需要拉取到没有返回为止，通过start参数

参数名	类型	是否必传	备注	样例
startDate	String	Y	开始日期，格式：YYYY-mm-dd	2020-03-01
endDate	String	Y	结束日期，格式：YYYY-mm-dd	2020-03-02
timezone	String	N	时区，枚举值，仅支持："UTC+8"、"UTC+0"、"UTC-8"。不传默认为"UTC+0"	UTC+8
currency	String	N	币种：不传默认USD 仅支持USD CNY	USD
bidType	int	N	竞价类型：不传默认所有，1 常规类型 2 竞价类型	0
appIdList	String[]	N	开发者后台的应用ID列表，不传默认为当前账号下所有app
start	Int	N	偏移量，表示从第几条数据开始，默认为0	0
limit	Int	N	每次拉取数据的最大条数，默认是1000，可选[1,20000]之间的任意整数	100
groupBy	String[]	N	date（日期，默认值）, appId（应用）, placementId（广告位）, adFormat（广告类型）, area(ISO 3166-1二位国家地区代码), network（广告网络）, networkPlacementId（三方广告网络的广告位）, adSceneId（广告场景，`三方广告网络不支持此维度，选择后不会返回三方广告网络统计数据`）, sdk (sdk版本，`三方广告网络不支持此维度，选择后不会返回三方广告网络统计数据`) , channel (渠道，`三方广告网络不支持此维度，选择后不会返回三方广告网络统计数据`) , appVersion (应用版本，`三方广告网络不支持此维度，选择后不会返回三方广告网络统计数据`) , idfa (IDFA授权，`三方广告网络不支持此维度，选择后不会返回三方广告网络统计数据`) , bucketId (A/B测试分组，`三方广告网络不支持此维度，选择后不会返回三方广告网络统计数据`)	["network",”networkPlacementId"]
metric	String[]	N	all（所有指标，默认值）, dau（TradPlus统计的日活跃用户数量(app级别)）, deu（TradPlus统计的每日观看广告用户数）, arpu（TradPlus统计的用户平均收入）, newUsers（TradPlus统计的新增用户(app级别)）, requestApi（三方广告网络的请求数）, fillApi（三方广告网络的填充数）, fillrateApi（三方广告网络的填充率）, impressionApi（三方广告网络的展示数）, clickApi（三方广告网络的点击数）, ecpmApi（三方广告网络的ECPM）, ctrApi（三方广告网络的点击率）, revenue（三方广告网络的收入）, bidRequestApi（三方广告网络的竞价请求数）, bidResponseApi（三方广告网络的竞价响应数）, bidResponseRateApi（三方广告网络的竞价响应率）, bidWinRateApi（三方广告网络的竞价胜出率）, appRequest（TradPlus统计的应用请求数）, enterAdScene（TradPlus统计的进入广告场景数）, enterAdSceneUsers（TradPlus统计的进入广告场景用户数）, request（TradPlus统计的请求数）, bidRequest（TradPlus统计的竞价请求数）, bidResponse（TradPlus统计的竞价响应数）, bidResponseRate（TradPlus统计的竞价响应率）, bidWinRate（TradPlus统计的竞价胜出率）, impression（TradPlus统计的展示数）, fill（TradPlus统计的填充数）, click（TradPlus统计的点击数）, clickUsers（TradPlus统计的点击用户数）, ctr（TradPlus统计的点击率）, estimateRevenue（TradPlus统计的埋点展示占比预估收入）, eventRevenue(TradPlus统计的埋点收入)， sdk (TradPlus记录的sdk版本) , channel (TradPlus记录的渠道) , appVersion (TradPlus记录的应用版本) , idfa (TradPlus记录的IDFA授权) , bucketName (TradPlus记录的A/B测试组名称) , countryName (TradPlus记录的国家)	["dau","request","fillrateApi"]

3.4 返回参数_v4

HTTP Content-Type: application/json

字段	类型	备注
code	Int	状态码详见下方状态码定义列表
total	Int	总数据量
timezone	String	时区
message	String	提示信息
items	Array	记录

items元素结构如下：

字段	类型	是否必传	备注
date	String	N	日期，格式：YYYY-mm-dd
appId	String	N	应用ID，`groupBy`有`appId`维度才有返回
platform	Int	N	应用的系统平台 (1 Android, 2 iOS)，`groupBy`有`appId`维度才有返回
packageName	String	N	应用的包名，`groupBy`有`appId`维度才有返回
placementId	String	N	广告位ID，`groupBy`有`placementId`维度才有返回
placementName	String	N	广告位名字，`groupBy`有`placementId`维度才有返回
adFormat	Int	N	广告位类型，`groupBy`有`adFormat`维度才有返回
adFormatName	String	N	广告位类型名字，`groupBy`有`adFormat`维度才有返回
area	String	N	国家地区编码(ISO 3166-1二位国家地区代码)，`groupBy`有`area`维度才有返回
network	Int	N	广告网络ID，`groupBy`有`network`维度才有返回
networkName	String	N	广告网络名字，`groupBy`有`network`维度才有返回
networkPlacementId	String	N	广告网络的广告位ID信息，`groupBy`有`networkPlacementId`维度才有返回
networkPlacementName	String	N	广告网络的广告源名称，`groupBy`有`networkPlacementId`维度才有返回
networkPlacementInfo	String	N	广告网络的广告位详细信息，`groupBy`有`networkPlacementId`维度才有返回
adSceneId	String	N	广告场景ID，`groupBy`有`adSceneId`维度才有返回
adSceneName	String	N	广告场景名称，`groupBy`有`adSceneId`维度才有返回
dau	Int	N	TradPlus统计的日活跃用户数量(app级别)
deu	Int	N	TradPlus统计的每日观看广告用户数
arpu	Float	N	TradPlus统计的用户平均收入
newUsers	Int	N	TradPlus统计的新增用户(app级别)
newUserRate	Float	N	TradPlus统计的新增用户占比(app级别)
bidRequestApi	Int	N	三方广告网络的竞价请求数
bidResponseApi	Int	N	三方广告网络的竞价响应数
bidResponseRateApi	Float	N	三方广告网络的竞价响应率
bidWinRateApi	Float	N	三方广告网络的竞价胜出率
requestApi	Int	N	三方广告网络的请求数
fillApi	Int	N	三方广告网络的填充数
fillrateApi	Float	N	三方广告网络的填充率
impressionApi	Int	N	三方广告网络的展示数
clickApi	Int	N	三方广告网络的点击数
ctrApi	Float	N	三方广告网络的点击率
ecpmApi	Float	N	三方广告网络的ECPM
Revenue	Float	N	三方广告网络的收益
appRequest	Int	N	TradPlus统计的应用请求数
enterAdScene	Int	N	TradPlus统计的进入广告场景次数
enterAdSceneUsers	Int	N	TradPlus统计的进入广告场景用户数
bidRequest	Int	N	TradPlus统计的竞价请求数
bidResponse	Int	N	TradPlus统计的竞价响应数
bidResponseRate	Float	N	TradPlus统计的竞价响应率
bidWinRate	Float	N	TradPlus统计的竞价胜出率
request	Int	N	TradPlus统计的请求数
fill	Int	N	TradPlus统计的填充数
fillrate	Float	N	TradPlus统计的填充率
impression	Int	N	TradPlus统计的展示次数
impressionRatio	Float	N	TradPlus统计的展示占比
click	Int	N	TradPlus统计的点击次数
clickUsers	Int	N	TradPlus统计的点击用户数
ctr	Float	N	TradPlus统计的点击率
estimateRevenue	Float	N	TradPlus统计的预估收益
idfa	Int	N	IDFA授权
bucketName	String	N	A/B测试组名称
countryName	String	N	国家
channel	String	N	渠道
sdk	String	N	sdk版本
appVersion	String	N	应用版本
eventRevenue	Float	N	TradPlus统计的埋点收入

各时区完整数据更新时间点： UTC+0 20(北京时间) UTC+8 21点(北京时间) UTC-8 次日2点(北京时间)

三方广告网络时区说明

3.5 样例_v4

请求样例

{
    "startDate": "2021-07-01",
    "endDate"  : "2021-07-07",
    "timezone" : "UTC+8",
    "currency" : "USD",
    "start": 0,
    "limit": 1000,
    "groupBy":
    [
        "date",
        "appId",
        "placementId"
    ],
    "metric":
    [
        "all"
    ]
}

响应样例

{
    "items": [
        {
            "date": "2021-07-01",
            "appId": "6640E7E3BDAC951B8F28D4C8C50E50B5",
            "packageName": "com.unstall.meetdelete",
            "placementId": "B514A432CE5E96A44BD2E313AC3323AB",
            "placementName": "Banner_1",
            "adFormat": 0,              //groupBy有adFormat维度才有返回
            "adFormatName": "",         //groupBy有adFormat维度才有返回
            "area": "YE",               //groupBy有area维度才有返回
            "network": 0,               //groupBy有network维度才有返回
            "networkName": "",          //groupBy有network维度才有返回
            "networkPlacementName": "", //groupBy有networkPlacementId维度才有返回
            "networkPlacementId": "",   //groupBy有networkPlacementId维度才有返回
            "networkPlacementInfo": "", //groupBy有networkPlacementId维度才有返回
            "adSceneId":"",             //groupBy有adSceneId维度才有返回
            "adSceneName":"",           //groupBy有adSceneId维度才有返回
            "requestApi": 19433,
            "fillApi":150,
            "fillrateApi": 0.13,
            "impressionApi": 1989,
            "clickApi": 236,
            "ecpmApi": 2.21,
            "ctrApi": 0.14,
            "Revenue": 6.59,
            "dau": 679,
            "deu": 223,
            "arpu": 0.01,
            "newUsers": 349,
            "newUserRate": 0.63,
            "enterAdScene":4123,
            "enterAdSceneUsers":3178,
            "impression": 44106,
            "impressionRatio": 0.8507,
            "click": 20358,
            "clickUsers": 16829,
            "ctr": 0.4616,
            "estimateRevenue": 5.31,
            "request": 19432,
            "bidRequestApi": 8655,
            "bidRequest": 9152,
            "bidResponseApi": 4582,
            "bidResponse": 5625,
            "bidResponseRateApi": 0.5294,
            "bidResponseRate": 0.6175,
            "bidWinRateApi": 3.4547,
            "bidWinRate": 4.2409,
			"appRequest": 1549732,
            "idfa": 0,
            "bucketName": "",
            "countryName": "",
            "channel": "",
            "sdk": "",
            "appVersion": ""
        }
    ],
    "timezone": "UTC+8"
}

4. 用户价值1-90天报表 API

4.1 URL

https://openapi.tradplusad.com/v2/ltv

4.2 请求协议

HTTP POST HTTP Content-Type: application/json

4.3请求参数

数据需要拉取到没有返回为止，通过start参数

参数名	类型	是否必传	备注	样例
startDate	String	Y	开始日期，格式：YYYY-mm-dd	2020-03-01
endDate	String	Y	结束日期，格式：YYYY-mm-dd	2020-03-02
timezone	String	N	时区，枚举值，仅支持："UTC+8"、"UTC+0"、"UTC-8"。不传默认为"UTC+0"	UTC+8
currency	String	N	币种：不传默认USD 仅支持USD CNY	USD
appIdList	String[]	N	开发者后台的应用ID列表，不传默认为当前账号下所有app
areaList	String[]	N	ISO 3166-1二位国家地区代码的列表，不传默认为全部地区	CN
start	Int	N	偏移量，表示从第几条数据开始，默认为0	0
limit	Int	N	每次拉取数据的最大条数，默认是1000，可选[1,1000]之间的任意整数	100
groupBy	String[]	Y	date 日期，`必填` app 应用，`必填` area 国家 placementId 广告位 appVersion 应用版本 channel 渠道	["date","app","area"]
metric	String[]	Y	ltvxx列表，最多支持90天，只传一个["all"] 代表全部，例如ltv20代表第20天的累积收益	["ltv11","ltv12","ltv13"]

4.4 返回参数

HTTP Content-Type: application/json

字段1	类型	备注
timezone	String	时区
items	Array	记录

items元素结构如下：

字段	类型	备注
date	String	日期，格式：YYYY-mm-dd
appId	String	应用ID
appName	String	应用名称
appVersion	String	应用版本
channel	String	渠道
placementId	String	广告位ID
placementName	String	广告位名称
newUserNum	Int64	新增用户数
ltvxx	Float64	ltv数字（1-90）

备注:每日北京时间21点更新昨天数据

4.5 样例

请求样例：

{
    "startDate": "2021-07-01",
    "endDate"  : "2021-07-07",
    "timezone" : "UTC+0",
    "currency" : "USD",
    "start": 0,
    "limit": 1000,
    "groupBy":
    [
        "date",
        "app"
    ],
    "metric":
    [
        "all"
    ]
}

响应样例：

{
    "items":
    [
        {
            "appId": "6640E7E3BDAC951B8F28D4C8C50E50B5",
            "appName": "Banner_1",
            "date": "2021-07-01",
            "newUserNum": 2,
            "ltv1": 9.54,
            "ltv10": 0,
            "ltv11": 0,
            "ltv12": 0,
            "ltv13": 0,
            "ltv14": 0,
            "ltv15": 0,
            "ltv16": 0,
            "ltv17": 0,
            "ltv18": 0,
            "ltv19": 0,
            "ltv2": 0,
            "ltv20": 0,
            "ltv21": 0,
            "ltv22": 0,
            "ltv23": 0,
            "ltv24": 0,
            "ltv25": 0,
            "ltv26": 0,
            "ltv27": 0,
            "ltv28": 0,
            "ltv29": 0,
            "ltv3": 0,
            "ltv30": 0,
            "ltv31": 0,
            "ltv32": 0,
            "ltv33": 0,
            "ltv34": 0,
            "ltv35": 0,
            "ltv36": 0,
            "ltv37": 0,
            "ltv38": 0,
            "ltv39": 0,
            "ltv4": 0,
            "ltv40": 0,
            "ltv41": 0,
            "ltv42": 0,
            "ltv43": 0,
            "ltv44": 0,
            "ltv45": 0,
            "ltv46": 0,
            "ltv47": 0,
            "ltv48": 0,
            "ltv49": 0,
            "ltv5": 0,
            "ltv50": 0,
            "ltv51": 0,
            "ltv52": 0,
            "ltv53": 0,
            "ltv54": 0,
            "ltv55": 0,
            "ltv56": 0,
            "ltv57": 0,
            "ltv58": 0,
            "ltv59": 0,
            "ltv6": 0,
            "ltv60": 0,
            "ltv61": 0,
            "ltv62": 0,
            "ltv63": 0,
            "ltv64": 0,
            "ltv65": 0,
            "ltv66": 0,
            "ltv67": 0,
            "ltv68": 0,
            "ltv69": 0,
            "ltv7": 0,
            "ltv70": 0,
            "ltv71": 0,
            "ltv72": 0,
            "ltv73": 0,
            "ltv74": 0,
            "ltv75": 0,
            "ltv76": 0,
            "ltv77": 0,
            "ltv78": 0,
            "ltv79": 0,
            "ltv8": 0,
            "ltv80": 0,
            "ltv81": 0,
            "ltv82": 0,
            "ltv83": 0,
            "ltv84": 0,
            "ltv85": 0,
            "ltv86": 0,
            "ltv87": 0,
            "ltv88": 0,
            "ltv89": 0,
            "ltv9": 0,
            "ltv90": 0
        }
    ],
    "timezone": "UTC+0"
}

5 用户留存2-90天报表 API

5.1 URL

https://openapi.tradplusad.com/v2/userActive

5.2 请求协议

HTTP POST HTTP Content-Type: application/json

5.3请求参数

数据需要拉取到没有返回为止，通过start参数

参数名	类型	是否必传	备注	样例
startDate	String	Y	开始日期，格式：YYYY-mm-dd	2020-03-01
endDate	String	Y	结束日期，格式：YYYY-mm-dd	2020-03-02
timezone	String	N	时区，枚举值，仅支持："UTC+8"、"UTC+0"、"UTC-8"。不传默认为"UTC+0"	UTC+8
appIdList	String[]	N	开发者后台的应用ID列表，不传默认为当前账号下所有app
areaList	String[]	N	ISO 3166-1二位国家地区代码的列表，不传默认为全部地区	CN
start	Int	N	偏移量，表示从第几条数据开始，默认为0	0
limit	Int	N	每次拉取数据的最大条数，默认是1000，可选[1,1000]之间的任意整数	100
groupBy	String[]	Y	date 日期，`必填` app 应用，`必填` area 国家 appVersion 应用版本 channel 渠道	["date","app","area"]
metric	String[]	Y	kpxx 列表，最多支持90天，只传一个["all"] 代表全部，例如kp20 代表第20天的累积收益	["kp22","kp23"]

5.4 返回参数

HTTP Content-Type: application/json

字段	类型	备注
timezone	String	时区
items	Array	记录

items元素结构如下：

字段	类型	备注
date	String	日期，格式：YYYY-mm-dd
appId	String	应用ID
appName	String	应用版本
appVersion	String	应用版本
channel	String	渠道
kpxx	Float64	kp数字（1-90）

备注:每日北京时间21点更新昨天数据

5.5 样例

请求样例：

{
    "startDate": "2021-07-01",
    "endDate"  : "2021-07-07",
    "timezone" : "UTC+0",
    "currency" : "USD",
    "start": 0,
    "limit": 1000,
    "groupBy":
    [
        "date",
        "app"
    ],
    "metric":
    [
        "all"
    ]
}

响应样例：

{
    "items": [
        {
            "appId": "FDC48B1D9D9E1F5CBD0C327159C8191C",
            "appName": "Banner_1",
            "date": "2021-07-01",
            "kp1": 2.31,
            "kp10": 0,
            "kp11": 0,
            "kp12": 0,
            "kp13": 0,
            "kp14": 0,
            "kp15": 0,
            "kp16": 0,
            "kp17": 0,
            "kp18": 0,
            "kp19": 0,
            "kp2": 0,
            "kp20": 0,
            "kp21": 0,
            "kp22": 0,
            "kp23": 0,
            "kp24": 0,
            "kp25": 0,
            "kp26": 0,
            "kp27": 0,
            "kp28": 0,
            "kp29": 0,
            "kp3": 0,
            "kp30": 0,
            "kp31": 0,
            "kp32": 0,
            "kp33": 0,
            "kp34": 0,
            "kp35": 0,
            "kp36": 0,
            "kp37": 0,
            "kp38": 0,
            "kp39": 0,
            "kp4": 0,
            "kp40": 0,
            "kp41": 0,
            "kp42": 0,
            "kp43": 0,
            "kp44": 0,
            "kp45": 0,
            "kp46": 0,
            "kp47": 0,
            "kp48": 0,
            "kp49": 0,
            "kp5": 0,
            "kp50": 0,
            "kp51": 0,
            "kp52": 0,
            "kp53": 0,
            "kp54": 0,
            "kp55": 0,
            "kp56": 0,
            "kp57": 0,
            "kp58": 0,
            "kp59": 0,
            "kp6": 0,
            "kp60": 0,
            "kp61": 0,
            "kp62": 0,
            "kp63": 0,
            "kp64": 0,
            "kp65": 0,
            "kp66": 0,
            "kp67": 0,
            "kp68": 0,
            "kp69": 0,
            "kp7": 0,
            "kp70": 0,
            "kp71": 0,
            "kp72": 0,
            "kp73": 0,
            "kp74": 0,
            "kp75": 0,
            "kp76": 0,
            "kp77": 0,
            "kp78": 0,
            "kp79": 0,
            "kp8": 0,
            "kp80": 0,
            "kp81": 0,
            "kp82": 0,
            "kp83": 0,
            "kp84": 0,
            "kp85": 0,
            "kp86": 0,
            "kp87": 0,
            "kp88": 0,
            "kp89": 0,
            "kp9": 0,
            "kp90": 0
        }
    ],
    "timezone": "UTC+0"
}

广告网络ID

id	备注
1	Facebook
2	Admob
4	AdColony
5	Unity Ads
6	Tapjoy
7	Liftoff
9	Applovin
10	IronSource
15	Chartboost
16	Tencent Ads
17	穿山甲
18	Mintegral
19	Pangle
20	Kuaishou Ads
21	Sigmob
23	Inmobi
24	Fyber
25	Youdao
27	crosspro
30	Helium
31	Maio
32	Criteo
33	Mytarget
34	ogury
36	Appnext
37	Kidoz
38	Smaato
41	Huawei Ads
43	Baidu
44	Klevin
45	A4G
46	米盟
47	Super Awesome
48	Google Ad Manager
49	GroMore
50	Yandex
51	My Network
52	小步科技
54	Appic (海外)
55	zMaticoo
56	ReklamUp
57	Bigo
58	BeiZi
59	Okspin
60	ONEMOB
61	Appic(China)
62	LeYou
63	Dirchlet(TapTap)
64	PremiumAds
65	zMaticoo（H5）
66	My Network 2
67	GreedyGame
68	AlgoriX
69	BeesAds
70	APS
71	Mango X
72	章鱼移动
73	TanX
74	TaurusX
75	KwaiAd
76	Columbus
77	YSO
78	Vivo
79	OPPO广告联盟

广告类型

id	备注
1	原生
2	插屏
3	开屏
4	横幅
5	激励视频
6	积分墙

code 状态码定义

数值	含义
200	成功
401	用户校验信息缺失或者错误
10001	请求参数错误
10005	开始或结束时间错误
10006	维度参数错误
10007	请求指标错误

修订历史​

注意事项​

1. 接口校验​

1.1 协议​

1.2 Header公共请求参数​

2. 综合报表数据查询 API​

2.1 URL​

2.2 请求协议​

2.3请求参数​

2.4 返回参数​

2.5 样例​

请求样例​

响应样例​

3. 综合报表数据查询 API v4​

3.1 URL_v4​

3.2 请求协议_v4​

3.3请求参数_v4​

3.4 返回参数_v4​

3.5 样例_v4​

请求样例​

响应样例​

4. 用户价值1-90天报表 API​

4.1 URL​

4.2 请求协议​

4.3请求参数​

4.4 返回参数​

4.5 样例​

请求样例：​

响应样例：​

5 用户留存2-90天报表 API​

5.1 URL​

5.2 请求协议​

5.3请求参数​

5.4 返回参数​

5.5 样例​

请求样例：​

响应样例：​

广告网络ID​

广告类型​

code 状态码定义​

修订历史

注意事项

1. 接口校验

1.1 协议

1.2 Header公共请求参数

2. 综合报表数据查询 API

2.1 URL

2.2 请求协议

2.3请求参数

2.4 返回参数

2.5 样例

请求样例

响应样例

3. 综合报表数据查询 API v4

3.1 URL_v4

3.2 请求协议_v4

3.3请求参数_v4

3.4 返回参数_v4

3.5 样例_v4

请求样例

响应样例

4. 用户价值1-90天报表 API

4.1 URL

4.2 请求协议

4.3请求参数

4.4 返回参数

4.5 样例

请求样例：

响应样例：

5 用户留存2-90天报表 API

5.1 URL

5.2 请求协议

5.3请求参数

5.4 返回参数

5.5 样例

请求样例：

响应样例：

广告网络ID

广告类型

code 状态码定义