Skip to main content

Device Reporting API

Change Log#

versiondatenotes
v2.0-supports device report
v3.0-supports customized user ID query

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. Device Reporting API#

2.1.1 URL_V3(recommended)#

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

2.1.2 Request method_V3#

HTTP POST
HTTP Content-Type: application/json

2.1.3 Request params_V3#

paramstyperequirednotessample
dateStringYdate, format:YYYY-mm-dd,Only supports one day2020-03-01
timezoneStringNreport time zone ,Only support:"UTC+8"、"UTC+0"、"UTC-8"。default:"UTC+0"UTC+0
currencyStringNcurrency。default : USD,Only support:USD CNYUSD
appIdStringYAPPID,Single choice

2.1.4 Return data_V3#

The data file is CSV, explode by ',' .
fieldstypenotes
dateTimeStampintTime Stamp
appIdStringAPP ID(tradplus)
placementIdStringPlacement ID (tradplus)
placementNameStringPlacement name (tradplus)
adFormatIntAd slot type
adFormatNameStringAd slot name
areaStringCountry code
networkIntNetwork ID
networkNameStringNetwork Name
networkPlacementIdStringNetwork Placement Id
networkPlacementNameStringNetwork Placement Name (tradplus)
networkPlacementInfoStringNetwork Placement Information
androidIdStringDevice id,androidid
gaidStringGoogle advertising ID
idfaStringIdentity for Advertisers
userIdStringCustom User ID
channelStringChannel
sub_channelStringSub-channel
impressionIntImpression number(tradplus)
clickIntClick number(tradplus)
revenueFloatRevenue
ecpmFloatEcpm
oaidStringAndroid device ID
idfvStringIdentifier for Vendor
os_versionStringVersion of OS
att_statusIntStatus of Apple's ATT (0: notDetermined; 1: restricted; 2: denied; 3: authorized)
  • The API will return 3 URLs for downloading csv files, the URL is valid for 15 mins, please send another request if it is over 15 mins.
  • Please note that, the complete data should contain the 3 files.
  • The user data will be sent to different computing ceters according to user's location, please don't worry if you found one of the center don't have any data.
  • Since Ad Networks have different report time zones, it will be more accurate to request the last two days' data, or update the historical data(last two days normally) after getting response.

note: Data freshness:

  • UTC+8 data: 5:00 (Beijing Time)
  • UTC+0 data: 15:00 (Beijing Time)
  • UTC-8 data: day2 at 2:00 (Beijing Time)

2.1.5 Sample#

Reqeust Sample:#
{
"date" : "2021-07-1",
"timezone" : "UTC+0",
"currency" : "USD",
"appId" : "6640E7E3BDAC951B8F28D4C8C50E50B5"
}
Response Sample:#
{
"url_cn": "https://tradplus-tracking-data-cn.oss-cn-shanghai.aliyuncs.com/user_api_v3%2F20210625%2F6640E7E3BDAC951B8F28D4C8C50E50B5.csv?Expires=1631502408&OSSAccessKeyId=LTAI4G15mptjxrMChg6SV1pF&Signature=R4x8c34%2Ft3pmv%2FennYc%2Fxuv%2FWrU%3D",
"url_en": "https://tradplus-tracking-data-de.oss-eu-central-1.aliyuncs.com/user_api_v3%2F20210625%2F6640E7E3BDAC951B8F28D4C8C50E50B5.csv?Expires=1631502408&OSSAccessKeyId=LTAI4G15mptjxrMChg6SV1pF&Signature=yulxcBdh%2F3%2BzjJP9HVVG5SeQ%2FDY%3D",
"url_in": "https://tradplus-tracking-data-in.oss-ap-south-1.aliyuncs.com/user_api_v3%2F20210625%2F6640E7E3BDAC951B8F28D4C8C50E50B5.csv?Expires=1631502408&OSSAccessKeyId=LTAI4G15mptjxrMChg6SV1pF&Signature=FhlFPsyWmV88NHxAvMJK5SAbKXk%3D"
}

2.2.1 URL_V2 (deprecated)#

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

2.2.2 Request method_V2#

HTTP POST
HTTP Content-Type: application/json

2.2.3 Request params_V2#

paramstyperequirednotessample
dateStringYdate, format:YYYY-mm-dd,Only supports one day2020-03-01
currencyStringNcurrency。default : USD,Only support:USD CNYUSD
appIdStringYAPPID,Single choice

2.2.4 Return data_V2#

The data file is CSV, explode by ',' .
fieldstypenotes
dateTimeStampintTime Stamp
appIdStringAPP ID(tradplus)
placementIdStringPlacement ID (tradplus)
placementNameStringPlacement name (tradplus)
adFormatIntAd slot type
adFormatNameStringAd slot name
areaStringCountry code
networkIntNetwork ID
networkNameStringNetwork name
networkPlacementIdStringNetwork Placement Id
networkPlacementNameStringNetwork Placement Name (tradplus)
networkPlacementInfoStringNetwork Placement Information
androidIdStringDevice id,androidid
gaidStringGoogle advertising ID
idfaStringIdentity for Advertisers
impressionIntImpression number(tradplus)
clickIntClick number(tradplus)
revenueFloatRevenue
ecpmFloatEcpm
  • The API will return 3 URLs for downloading csv files, the URL is valid for 15 mins, please send another request if it is over 15 mins.
  • Please note that, the complete data should contain the 3 files.
  • The user data will be sent to different computing ceters according to user's location, please don't worry if you found one of the center don't have any data.
  • Since Ad Networks have different report time zones, it will be more accurate to request the last two days' data, or update the historical data(last two days normally) after getting response.

note: Data freshness:

  • UTC+8 data: 5:00 (Beijing Time)
  • UTC+0 data: 15:00 (Beijing Time)
  • UTC-8 data: day2 at 2:00 (Beijing Time)