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,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 in param 'group_by'
packageNameStringNPackage name
placementIdStringNPlacement ID (tradplus).Return if in param 'group_by'
placementNameStringNPlacement name (tradplus).Return if in param 'group_by'
adFormatIntNAd slot type.Return if in param 'group_by'
adFormatNameStringNAd slot name.Return if in param 'group_by'
areaStringNCountry code.Return if in param 'group_by'
networkIntNNetwork ID.Return if in param 'group_by'
networkNameStringNNetwork name.Return if in param 'group_by'
networkPlacementIdStringNNetwork Placement Id.Return if in param 'group_by'
networkPlacementNameStringNNetwork Placement Name (tradplus).Return if in param 'group_by'
networkPlacementInfoStringNNetwork Placement Information
dauIntYDaily actvie users
deuIntYDaily engaged users
arpuFloatYAverage revenue per daily actvie user
newUsersIntYNew Users
newUserRateFloatYNew User Rate
requestApiIntYNetwork data : request 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

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

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

network ID#

idnotes
1Facebook
2Admob
3Mopub
4AdColony
5Unity Ads
6Tapjoy
7Vungle
9Applovin
10IronSource
15Chartboost
16Tencent Ads
17Pangle(cn)
18Mintegral
19Pangle
20Kuaishou Ads
21Sigmob

AD Format#

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