Note:
- The report is delayed by one day. It is recommended to pull yesterday's data again at around 10 p.m. on the same day (third-party data may continue to be updated). Under normal circumstances, the data will be complete at this time.
1. Request URL
https://api.toponad.net/v3/impnewuserreport
2. Request method
POST
3. Request params
params | type | required | notes | sample |
---|---|---|---|---|
start_date | Int | Y | Start date, format: YYYYmmdd | 20190501 |
end_date | Int | Y | End date, format: YYYYmmdd | 20190506 |
app_id_list | Array[String] | Y | App ID list. For now, only one can be transmitted. | ["a600e6fbeac98c"] |
placement_id_list | Array[String] | N | Placement ID list | ["b600e6fbeac98c"] |
geo_short_list | Array[String] | N | Country Short Code list | ["US"] |
channel_list | Array[String] | N | Channel list | [“MyChannel”] |
time_zone | String | Y | Report timezone, UTC+8, UTC+0, UTC-8, default UTC+8 | UTC+0 |
start | Int | N | Offset, default 0 | 0 |
limit | Int | N | Limit row number. default 1000. [1,1000] | default 1000 |
group_by | Array[String] | N | Group by dimension. If not specified, the default value is 'date_time'. Supported dimensions are described below. date_time (Date, default value), app_id (Application), placement_id (Placement), geo_short (Country short code), channel (Channel) |
["date_time","app_id"] |
4. Return data
fields | type | required | notes |
---|---|---|---|
records | Array[Object] | N | Record, object array. The structure of each record is shown in the records element structure below. It is empty when there is no data. |
count | Int | N | count of the row numbers |
records:
fields | type | required | notes |
---|---|---|---|
date_time | Int | N | Date,format: YYYYmmdd. Return if in param 'group_by' |
app_id | String | N | App ID. Return if in param 'group_by' |
app_name | String | N | App name. Return if 'app_id' in param 'group_by' |
placement_id | String | N | Placement ID. Return if in param 'group_by' |
placement_name | String | N | Placement name. Return if 'placement_id' in param 'group_by' |
geo_short | String | N | Country Short Code. Return if in param 'group_by' |
channel | String | N | Channel, response by group_by select channel |
new_user | Int | Y | New User Count |
impression_xx | String | Y |
impression_(num) (1-60) Note: The developer backend shows the total number of impressions for the day and accumulates the previous day's impressions daily. The API returns the average number of impressions for new users. For example: |
5. Sample
Request sample:
curl --location --request POST 'https://api.toponad.net/v3/impnewuserreport' \
--header 'X-Up-Key: 877f8ae9c6e9ca82c0==5b5fff594c373axxx' \
--header 'X-Up-Signature: CE12B506DBCD868C2C6F09E08C139CBC' \
--header 'X-Up-Timestamp: 1626161553000' \
--header 'Content-Type: application/json' \
--data-raw '{
"start_date":20211203,
"end_date":20211216,
"timezone_api":"UTC-8",
"offset":0,
"app_id_list": ["a5df88b5140222"],
"placement_id_list": ["b5df88bc03222c"],
"limit":1,
"group_by": ["date_time"]
}'
Return data sample:
{
"count": 14,
"records": [
{
"date_time": 20211203,
"new_user": 12000,
"impression_1": "2.612",
"impression_2": "1.5897",
"impression_3": "0.7926",
"impression_4": "0.3768",
"impression_5": "0.276",
"impression_6": "0.227",
"impression_7": "0.1569",
"impression_8": "0.159",
"impression_9": "0.1974",
"impression_10": "0.1485",
"impression_11": "0.086",
"impression_12": "0.073",
"impression_13": "0.0813",
"impression_14": "0.0541",
"impression_15": "0.0749",
"impression_16": "0",
"impression_17": "0",
"impression_18": "0",
"impression_19": "0",
"impression_20": "0",
"impression_21": "0",
"impression_22": "0",
"impression_23": "0",
"impression_24": "0",
"impression_25": "0",
"impression_26": "0",
"impression_27": "0",
"impression_28": "0",
"impression_29": "0",
"impression_30": "0",
"impression_31": "0",
"impression_32": "0",
"impression_33": "0",
"impression_34": "0",
"impression_35": "0",
"impression_36": "0",
"impression_37": "0",
"impression_38": "0",
"impression_39": "0",
"impression_40": "0",
"impression_41": "0",
"impression_42": "0",
"impression_43": "0",
"impression_44": "0",
"impression_45": "0",
"impression_46": "0",
"impression_47": "0",
"impression_48": "0",
"impression_49": "0",
"impression_50": "0",
"impression_51": "0",
"impression_52": "0",
"impression_53": "0",
"impression_54": "0",
"impression_55": "0",
"impression_56": "0",
"impression_57": "0",
"impression_58": "0",
"impression_59": "0",
"impression_60": "0"
}
]
}