Menu

Full report

1. Request URL

https://openapi.toponad.com/v2/fullreport

2. Request Method

POST

3. Request params

params type required notes sample
startdate Int Y start date, format: YYYYmmdd 20190501
enddate Int Y end date, format: YYYYmmdd 20190506
app_id_list Array[String] N app id ["xxxxx"]
placement_id_list Array[String] N placement id ["xxxxx"]
time_zone String N report time zone UTC-8, UTC+8, UTC+0
network_firm_id_list Array[int32] N network firm id list, some special network firm id descriptions:
1.Taku Adx: 66		 ['xxxxx']
adsource_id_list Array[int32] N adsource id list [121]
area_list Array[String] N country short code list ["US"]
placement_id String N Placement ID(single) xxxxx
group_by Array N Select a maximum of 6 within 10 days for query , select at most 3 for query 10 days ago: : date(default), app, placement, adformat, area, network, adsource, network firm id ["app","placement","area"]
metric Array N

return metrics. default(default values), all, dau, arpu, request, fillrate, impression, click, ctr, ecpm, revenue, request_api, fillrate_api, impression_api, click_api, ctr_api, ecpm_api, estimate_revenue, estimate_revenue_ecpm, ready_request, ready_rate, cy_estimate_revenue, cy_estimate_revenue_ecpm

bid_request(Bid Request, only Header Bidding ad sources return this data.)

bid_filled_request_rate(Bid Request Rate, only Header Bidding ad sources return this data.)

bid_filled_request_ecpm(Bid Request eCPM, only Header Bidding ad sources return this data. returned according to the developer account currency)

full_app_revenue(Regarding the overall revenue of the Meta App, it will only be returned when the current account has Meta data. Dimension splitting is not supported, and all dimensions will only return data corresponding to the Meta App)

 ["dau","arpu","request","click","ctr_api"]
start Int N offset 0
limit Int N limit row number. default 1000. [1,1000] 1000
  • default return metrics:

dau, arpu, request, fillrate, impression, click, ecpm, revenue, impression_api, click_api, ecpm_api

4. Return data

Dimensions and filters:

fields type required notes
count Int Y count of the return rows
date String Y date, format: YYYYmmdd. Return if in param 'group_by'
app.id String Y APP ID
app.name String N APP name
app.platform String N APP platform
app.pkg_name String N APP package name
placement Object N placement information, returned only when group_by selects the placement dimension
placement.id String N Placement ID
placement.name String N Placement name
adformat String N rewarded_video/interstitial/banner/native/splash. Return if in param 'group_by'
area String N country code.Return if in param 'group_by'
network_firm_id String N network firm id.Return if in param 'group_by'
network_firm String N network firm name.Return if in param 'group_by'
network String N account id.Return if in param 'group_by'
network_name String N account name.Return if in param 'group_by'
adsource Object N Ad source information, returned only when group_by selects the adsource dimension
adsource.network String N adsource network name
adsource.token String N adsource token.adsource's appid,slotid and so on.Return if in param 'group_by'
adsource.slot_id String N Third-party network ID
adsource.adsource_id String N Ad source ID
adsource.adsource_name String N Ad source name
scenario Object N Scenario information, returned only when group_by has the scenario dimension selected
scenario.id String N Taku internal scenario ID ("1" represents the default scene), which is only used to mark scenario within Taku. Developers should use the custom_uuid field to match scenario.
scenario.name String N Scenario name
scenario.custom_uuid String N Customized scenario  ID ("1" represents the default scene), which corresponds to the scenario  ID displayed on the backend scenario  management page, that is, the scenario  ID uploaded by the SDK
traffic_group Object N Segment information, returned only when group_by selects the traffic_group dimension
traffic_group.id String N Segment ID
traffic_group.name String N Segment name
traffic_group.segment_id Int N Segment digital id, note: in the default traffic grouping, segment_id=0, will not be returned
channel String N Channel name. This is returned only when the channel dimension is selected in group_by
sdk_version String N SDK version, group_by will only be returned if sdk_version is selected
app_version String N Application version. Only when the app_version dimension is selected in group_by will the value be returned.
time_zone String N UTC+8、UTC+0、UTC-8
currency String N currency

Indicator:

fields type required Indicator type Indicator classification notes
dau String N Taku data user behavior DAU, returned only according to the group_by condition
deu String N deu
engaged_rate String N engaged rate
imp_dau String N imp/dau
imp_deu String N imp/deu
dau_launch Int N Launch DAU. Note: this indicator will not be  returned when the value is 0.
new_users String N new users
new_user_rate String N New Users/DAU
cy_estimate_revenue String N Revenue  Estimate Revenue.
The estimate revenue, returned according to the developer account currency
cy_estimate_revenue_ecpm String N Estimate ecpm.
The estimate revenue ecpm, returned according to the developer account currency, it's calculated in the same way as estimate_revenue_ecpm
estimate_revenue String N (Will be offline later, not recommended) estimate revenue, currency: USD
estimate_revenue_ecpm String N (Will be offline later, not recommended)Estimate ecpm.
Taku calculates Estimate eCPM based on the total Estimate Revenue and Taku statistics Impressions, calculated as ( Estimate Revenue / Taku Impressions ) * 1000. Note: 1. Estimated eCPM available on current day ; 2. Non-bidding ad sources are based on manually filled-in eCPM price, and bidding ad sources are based on real-time bid price
ecpm String N eCPM.
Taku calculates eCPM based on the total Revenue( provided by Network's Reporting API ) and Taku statistics Impressions, calculated as ( Revenue / Taku Impressions ) * 1000. Note: eCPM is delayed by 1 day
ecpc String N eCPC.
Taku calculates eCPC based on actual revenue pulled from Network's reporting APIs and Taku-measured click data, calculated as (Revenue / Taku-tracked Clicks) × 1000.
Note: eCPC data is reported with a 1-day delay.
ecpr String N eCPR.
Taku calculates eCPR based on estimated revenue and tracked request volume, calculated as (Estimated Revenue / Taku-measured Requests) × 1000.
bid_request Int N Bidding data Bid Request, only Header Bidding ad sources return this data.
bid_filled_request_rate String N Bid Request Rate, only Header Bidding ad sources return this data.
bid_filled_request_ecpm String N Bid Fill eCPM, only Header Bidding ad sources return this data. returned according to the developer account currency
load String N Request Data Requests, note: some group_by dimensions (e.g. network_firm_id) are selected, the response is "0"
load_fillrate String N Request Fill Rate. Note: If some group_by dimensions (e.g. network_firm_id) are selected, this indicator will not be returned in the response.
loads_filled Int N Request Fill. Note: If some group_by dimensions (e.g. network_firm_id) are selected, or if the value is 0, this indicator will not be returned in the response.
request String N Attempts
fillrate String N Attempt Fill Rate
request_filled Int N Attempt Fill. Note: this indicator will not be  returned when the value is 0.
impression String N Impression 
impression_rate String N Impression Rate
click String N Click 
ctr String N CTR
ready_request String N Ad Ready  isReady
ready_rate String N isReady Rate
scenario_entry Int N Reach Scenario.Note: this indicator will not be  returned when the value is 0.
scenario_entry_ready_rate String N Scenario Ready Rate
day2_retention String N Other data Retention (no such indicator in the background)
revenue_gap String N Revenue GAP
ecpm_gap String N eCPM GAP
impression_gap String N Impression Gap
click_gap String N Click Gap
request_api String N API data Request Data Attempts API
fillrate_api String N Attempts Fill Rate API
impression_api String N Impressions API
click_api String N Clicks API
ctr_api String N CTR API
cy_arpu String N Revenue ARPDAU, this item is returned only if there is dau
Unit: based on the developer account currency
arpu String N (Will be offline later, not recommended) ARPDAU, this item is returned only if there is dau
Unit: USD
estimated_revenue_arpu String N Estimate ARPDAU, this item is returned only if there is dau
Unit: based on the developer account currency
revenue String N Revenue API, the currency is the developer account currency
ecpm_api String N eCPM API. Taku calculates eCPM API based on the total Revenue and Impressions API ( both are provided by Network's Reporting API ), calculated as ( Revenue / Impressions API ) * 1000. Note: eCPM is delayed by 1 day.
unit_ecpc String N eCPC API. Calculated as (Media Revenue / Media-side Clicks) * 1000. Note: eCPC API data is delayed by 1 day.
unit_ecpr String N eCPR API. Calculated as (Revenue API / Request API) * 1000. Note: Some Network do not support Request API data - please check this metric by individual Network. Note: eCPR API data is delayed by 1 day.

Skills

  1. get multiple app data: you can pass multiple app_id, and group by app.
  2. get multi-day data: startdate and enddate can be passed into a period of time, and group by date_time. since the data will not be updated very frequently, and the historical data will not be updated, it is recommended to update the data for the last 2 days every day.
  3. data summary: group by the data to the smallest dimension, and then calculate the sum after you get the result.

5. Sample

Request data sample:

{
​    "startdate": 20190706,
​    "enddate": 201907010,
​     "limit":120,  
​    "group_by":["adsource"],
​    "metric":["all"],
​    "start":0,
​    "app_id":"a5c41a9ed1679c",
​    "placement_id":""
}

Return data sample: 

{
​    "count": 64,
​    "records": [{
​        "adsource": {
​            "network": "TouTiao",
​            "token": "{\"app_id\":\"5008225\",\"slot_id\":\"908225577\",\"is_video\":\"1\"}"
​        },
​        "revenue": "12995.80"
​    }]
}
 
Previous
Reporting API
Next
Cohorts Report
Last modified: 2025-08-20Powered by