Skip to main content

Reporting API

Change Log#

versiondatenotes
v1.0-supports full report
v2.0-LTV & retention report

1. Authentication check#

1.1 Method#

HTTP

1.2 Header Params#

Authorization: Bearer {your token}

paramsnotessample
AuthorizationtokenBearer {your token}
curl -v -H "Authorization: Bearer 96d6b7ae-d522-45b4-b8ac-dc12008814ef" -d {post data} https://openapi.tradplusad.com/v2/allreport
method of getting token: "my account"-"Report API Key"- generate APK key

2. Full report API#

2.1 URL#

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

2.2 Request Method#

HTTP POST
HTTP Content-Type: application/json

2.3Request params#

Pass the start parameter
paramstyperequirednotessample
startDateStringYstart date,format:YYYY-mm-dd2020-03-01
endDateStringYend date,format:YYYY-mm-dd2020-03-02
timezoneStringNreport time zone ,Only support:"UTC+8"、"UTC+0"、"UTC-8"。default:"UTC+0"UTC+0
currencyStringNcurrency。default : USD,Only support:USD CNYUSD
appIdListString[]Napp id list
startIntNoffset0
limitIntNlimit row number. default 1000. [1,1000]100
groupByString[]Ndate,appId,placementId,adFormat,area,network,networkPlacementId[“network”,”networkPlacementId”]
metricString[]Nall,dau,deu,arpu,newUsers,requestApi,fillApi,fillrateApi,impressionApi,clickApi,ecpmApi,ctrApi,revenue[“dau”,”request”,”fillrateApi”]

2.4 Return data#

HTTP Content-Type: application/json
filedstypenotes
timezoneStringUTC+8、UTC+0、UTC-8
itemsArrayitems
Items:
filedstyperequirednotes
dateStringNDate,format:YYYY-mm-dd
appIdStringNAPP ID(tradplus).Return if appId is in param groupBy
packageNameStringNPackage name .Return if appId is in param groupBy
placementIdStringNPlacement ID (tradplus).Return if placementId is in param groupBy
placementNameStringNPlacement name (tradplus).Return if placementId is in param groupBy
adFormatIntNAd slot type.Return if adFormat is in param groupBy
adFormatNameStringNAd slot name.Return if adFormat is in param groupBy
areaStringNCountry code.Return if area is in param groupBy
networkIntNNetwork ID.Return if network is in param groupBy
networkNameStringNNetwork name.Return if network is in param groupBy
networkPlacementIdStringNNetwork Placement Id .Return if networkPlacementId is in param groupBy
networkPlacementNameStringNNetwork Placement Name (tradplus).Return if networkPlacementId is in param groupBy
networkPlacementInfoStringNNetwork Placement Information .Return if networkPlacementId is in param groupBy
dauIntYDaily actvie users
deuIntYDaily engaged users
arpuFloatYAverage revenue per daily actvie user
newUsersIntYNew Users
newUserRateFloatYNew User Rate
requestApiIntYNetwork data : request numbers
fillApiIntYNetwork data : fill numbers
fillrateApiFloatYNetwork data : fillrate
impressionApiIntYNetwork data : impression numbers
clickApiIntYNetwork data : click numbers
ctrApiFloatYNetwork data : ctr
ecpmApiFloatYNetwork data : eCPM
RevenueFloatYNetwork data : revenue
All Data freshness:
UTC+0 data: 20:00 (Beijing Time)
UTC+8 data: 21:00 (Beijing Time)
UTC-8 data: day2 at 2:00 (Beijing Time)

Network API Time Zone

2.5 Sample#

Reqeust Sample:#
{
"startDate": "2021-07-01",
"endDate" : "2021-07-07",
"timezone" : "UTC+0",
"currency" : "USD",
"start": 0,
"limit": 1000,
"groupBy":
[
"date",
"appId",
"placementId"
],
"metric":
[
"all"
]
}
Response Sample:#
{
"items": [
{
"date": "2021-07-01",
"appId": "6640E7E3BDAC951B8F28D4C8C50E50B5",
"packageName": "com.unstall.meetdelete",
"placementId": "B514A432CE5E96A44BD2E313AC3323AB",
"placementName": "Banner_1",
"adFormat": 0, //Return if adFormat is in param groupBy
"adFormatName": "", //Return if adFormat is in param groupBy
"area": "", //Return if area is in param groupBy
"network": 0, //Return if network is in param groupBy
"networkName": "", //Return if network is in param groupBy
"networkPlacementName": "", //Return if networkPlacementId is in param groupBy
"networkPlacementId": "", //Return if networkPlacementId is in param groupBy
"networkPlacementInfo": "", //Return if networkPlacementId is in param groupBy
"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
}
],
"timezone": "UTC+0"
}

3. Ltv 1-90 days report API#

3.1 URL#

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

3.2 Request Method#

HTTP POST
HTTP Content-Type: application/json

3.3Request params#

1. Pass the start parameter
paramstyperequirednotessample
startDateStringYstart date,format:YYYY-mm-dd2020-03-01
endDateStringYend date,format:YYYY-mm-dd2020-03-02
timezoneStringNreport time zone ,Only support:"UTC+8"、"UTC+0"、"UTC-8"。default:"UTC+0"UTC+0
currencyStringNcurrency。default : USD,Only support:USD CNYUSD
appIdListString[]Napp id list
areaListString[]Ncountry codeCN
startIntNoffset0
limitIntNlimit row number. default 1000. [1,1000]100
groupByString[]Ygroup by for:["date","app","area"]["date","app","area"]
metricString[]YWe provide 90 LTV in maximum["ltv11","ltv12","ltv13"]

3.4 Return data#

HTTP Content-Type: application/json
fieldstypenotes
timezoneStringUTC+8、UTC+0、UTC-8
itemsArrayitems
items:
fieldstypenotes
appIdStringapp app_id
appNameStringapp name
dateStringdate,format:YYYY-mm-dd
ltvxxFloat64ltv day(1-90)

> note:Yesterday's data is updated daily at 21:00 Beijing time

3.5 Sample#

Reqeust Sample:#
{
"startDate": "2021-07-01",
"endDate" : "2021-07-07",
"timezone" : "UTC+0",
"currency" : "USD",
"start": 0,
"limit": 1000,
"groupBy":
[
"date",
"app"
],
"metric":
[
"all"
]
}
Response Sample:#
{
"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"
}

4.Retention 2-60 day report API#

4.1 URL#

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

4.2 Request method#

HTTP POST
HTTP Content-Type: application/json

4.3Request params#

1. Pass the start parameter
paramstyperequirednotessample
startDateStringYstart date,format:YYYY-mm-dd2020-03-01
endDateStringYend date,format:YYYY-mm-dd2020-03-02
timezoneStringNreport time zone ,Only support:"UTC+8"、"UTC+0"、"UTC-8"。default:"UTC+0"UTC+0
appIdListString[]Napp id list
areaListString[]Ncountry codeCN
startIntNoffset0
limitIntNlimit row number. default 1000. [1,1000]100
groupByString[]Ygroup by for:["date","app","area"]["date","app","area"]
metricString[]YWe provide 90 user retention in maximum["keep22","keep23","keep24"]

4.4 Return data#

HTTP Content-Type: application/json
fieldstypenotes
timezoneStringUTC+8、UTC+0、UTC-8
itemsArrayitems
items:
fieldstypenotes
appIdStringapp app_id
appNameStringapp name
dateStringdate,format:YYYY-mm-dd
keepxxFloat64keep day(1-90)

> note:Yesterday's data is updated daily at 21:00 Beijing time

4.5 Sample#

Reqeust Sample:#
{
"startDate": "2021-07-01",
"endDate" : "2021-07-07",
"timezone" : "UTC+0",
"currency" : "USD",
"start": 0,
"limit": 1000,
"groupBy":
[
"date",
"app"
],
"metric":
[
"all"
]
}
Response Sample:#
{
"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"
}

network ID#

idnotes
1Facebook
2Admob
3Mopub
4AdColony
5Unity Ads
6Tapjoy
7Vungle
9Applovin
10IronSource
15Chartboost
16Tencent Ads
17Pangle(cn)
18Mintegral
19Pangle
20Kuaishou Ads
21Sigmob
23Inmobi
24Fyber
25Youdao
26DisplayIO JSTag
27crosspro
30Helium
31Maio
32Criteo
33Mytarget
34ogury
35joomob
36Appnext
37Kidoz
38Smaato
41Huawei Ads
43Baidu
44Klevin

AD Format#

idnotes
1Native
2Interstitial
3Splash
4Banner
5Rewarded Video
6Offerwall