Sub-Account Full Report

Note: Before accessing the API, please familiarize yourself with the API signing mechanism (refer to the API Authentication Guide), specifically the origin of certain HTTP request headers in the API request examples.

Pre-Use Instructions:

• After applying for access to the financial statements API: It may take approximately 2 to 3 hours before data becomes available (otherwise the data list will be empty; please be patient).

  (How to verify permissions: Log in to the Taku backend, navigate to the dropdown menu in the top-left corner → My Account → Key page. If the corresponding parameters for the Global Publisher Key are present, permissions are enabled. If not, please contact Taku Operations to activate permissions.)

• After successfully obtaining data, only data from one day prior to the date the sub-account was applied for can be retrieved. For example, if a sub-account was applied for on February 24th, only data from February 23rd and later dates can be obtained. Otherwise, revenue-related data (such as revenue, ecpm, etc.) cannot be retrieved.
• Historical data will not be updated (unless the original data was incomplete and re-fetched). Revenue-related metrics (revenue, ecpm, etc.) experience a two-day delay, i.e., T+2 delay. Taku statistics (impressions, click) update every two hours and will lag behind the developer dashboard by approximately 2 to 3 hours.

Usage Notes:

• When the dimension segment_id is present in the request parameter group_by, the response does not return API-related metrics (ecpm, revenue).
• Show DAU and DEU conditions:

             (1) The group_by condition must only include (one or any number of) the following dimensions: date, app, geo_short, placement.

             (2) If the date dimension is not selected in the group_by dimension, the requested date range must span only one day, meaning start_date=end_date.  

Tips for Use:

• Retrieve data for multiple apps: Pass in multiple app_ids in batches and group by app_id.
• Retrieving multi-day data: Pass a date range as start_date and end_date, then group by date. Since data updates are infrequent and historical data rarely changes, it is recommended to update only the most recent two days' data daily.
• Data aggregation: Group by the finest dimension, then perform the sum calculation after obtaining the results.

1. Request URL

https://api.toponad.net/v3/report/black/full

2. Request method

POST

3. Request params

params	type	required	notes	example
start_date	Int	Y	Start date, format: YYYYmmdd	20190501
end_date	Int	Y	End date, format: YYYYmmdd	20190501
currency	String	Y	The currency used for metrics such as revenue and ecpm can be selected from: USD, CNY
app_id_list	Array[String]	N	App ID List, maximum query of 100 entries	[“a600e6fbeac98c”],
placement_id_list	Array[String]	N	Placement ID List, maximum query of 100 entries
segment_id_list	Array[Int]	N	Segment ID List, maximum query of 100 entries
geo_short_list	Array[String]	N	Country Short Code List, maximum query of 100 entries	[“US”,"CN"]
start	Int	N	Offset number, indicating the starting position of the data row. Default value is 0.	0
limit	Int	N	The maximum number of records fetched per request. Default is 1000, maximum is 1000. Accepts values in the range [1,1000].
group_by	Array[String]	N	Group by dimension. If not specified, defaults to date dimension. Supported dimensions: date (Date), app_id (App ID), placement_id (Placement ID), segment_id (Segment ID), geo_short (Country Short Code),	["placement_id"]
metric	Array[String]	Y	To return a list of metrics, select at least one metric. When selecting ecpm, revenue must also be selected. Enumeration description: all (All Metrics), dau (DAU), deu (DEU), new_user (New Users num), impression_rate (Impression Rate), impression (Impression), click (Click), click_rate (Click Rate), ecpm (eCPM), revenue (Revenue API), load (Requests), load_fill_rate (Request Fill Rate),

5. Sample

Request sample: 

{
    "end_date": 20231212,
    "start_date": 20231212,
    "group_by": ["date","app_id"],
    "start": 0,
    "limit": 1000,
    "metric": ["all"],
    "currency": "USD"
}

Return sample: 

{
    "count": 1,
    "records": [
        {
            "date": 20231212,
            "loads": 208,
            "load_fill_rate": 0.99,
            "impression": 328,
            "impression_rate": 1.5769,
            "click": 14,
            "click_rate": 0.0426,
            "ecpm": 0.21,
            "dau": 106,
            "deu": 40,
            "new_user": 33,
            "revenue": 0.06,
            "app_id": "a63b688e08ab69"
        }
    ]
}