1. Request URL
https://api.toponad.net/v3/report/roi
2. Request method
POST
3. Request params
| params | type | required | notes | sample |
|---|---|---|---|---|
| roi_platform | Int | Y |
Roi attribution platform, enumeration value: 1: Adjust |
1 |
| start_date | Int | Y | Start date, format: YYYYmmdd | 20190501 |
| end_date | Int | Y | End date, format: YYYYmmdd | 20190506 |
| time_zone | String | Y | UTC+8, UTC+0, UTC-8, default UTC+8 | UTC+0 |
| nw_firm_id_list | Array[Int] | N |
Network Channel ID list, enumeration value: 100000：Oceanengine |
[100000] |
| app_id_list | Array[String] | N | App ID list. For now, only one can be transmitted. | ["a600e6fbeac98c"] |
| campaign_id_list | Array[String] | N | Campaign ID list | |
| ad_group_id_list | Array[String] | N | AdSet ID list | |
| creative_id_list | Array[String] | N | Ad ID list | |
| geo_short_list | Array[String] | N | Country Short Code list | ["US"] |
| 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. nw_firm_id (Network Channel), adgroup_id (AdSet), creative_id (Ad) |
["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' |
| nw_firm_id | Int | N | Network Channel ID. Return if in param 'group_by' |
| campaign_id | String | N | Campaign ID. Return if in param 'group_by' |
| adgroup_id | String | N | AdSet ID. Return if in param 'group_by' |
| creative_id | String | N | Ad ID. Return if in param 'group_by' |
| geo_short | String | N | Country Short Code. Return if in param 'group_by' |
| new_user | Int | Y | New User Count |
| new_user_gap | String | Y | New User Gap |
| cost | Float | Y | UA Cost |
| install | Int | Y | Install |
| install_price | String | Y | Install Price |
| roi_xx | String | Y | roi_day_(num) (1-60) |
5. Sample
Request sample:
curl --location --request POST 'https://api.toponad.net/v3/report/roi' \
--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": 20211026,
"end_date": 20211026,
"roi_platform": 1,
"nw_firm_id_list": [100002],
"time_zone": "UTC+8",
"group_by": ["date_time"],
"limit": 100,
"start": 0
}'Return data sample:
{
"count": 1,
"records": [
{
"date_time": 20211026,
"new_user": 13061,
"new_user_gap": "-0.4522",
"cost": 45901.0955949819,
"install": 23845,
"install_price": "1.924978",
"roi_1": "0.2386",
"roi_2": "0.2968",
"roi_3": "0.3228",
"roi_4": "0.3409",
"roi_5": "0.355",
"roi_6": "0.3672",
"roi_7": "0.3753",
"roi_8": "0.3808",
"roi_9": "0.3855",
"roi_10": "0.3889",
"roi_11": "0.393",
"roi_12": "0.3974",
"roi_13": "0.4011",
"roi_14": "0.4045",
"roi_15": "0.4077",
"roi_16": "0.4097",
"roi_17": "0.4121",
"roi_18": "0.4141",
"roi_19": "0.4169",
"roi_20": "0.4189",
"roi_21": "0.4211",
"roi_22": "0.4226",
"roi_23": "0.4244",
"roi_24": "0.426",
"roi_25": "0.4284",
"roi_26": "0.4302",
"roi_27": "0.4324",
"roi_28": "0.4339",
"roi_29": "0.4355",
"roi_30": "0.4373",
"roi_31": "0.4394",
"roi_32": "0.4409",
"roi_33": "0.4421",
"roi_34": "0.4436",
"roi_35": "0.4446",
"roi_36": "0.4457",
"roi_37": "0.4465",
"roi_38": "0.4474",
"roi_39": "0.4482",
"roi_40": "0.4495",
"roi_41": "0.4506",
"roi_42": "0.4514",
"roi_43": "0.452",
"roi_44": "0.4528",
"roi_45": "0.4535",
"roi_46": "0.4542",
"roi_47": "0.4552",
"roi_48": "0.4559",
"roi_49": "0.4564",
"roi_50": "0.4569",
"roi_51": "0.4575",
"roi_52": "0.4578",
"roi_53": "0.4587",
"roi_54": "0.4594",
"roi_55": "0.4599",
"roi_56": "0.4604",
"roi_57": "0.461",
"roi_58": "0.4615",
"roi_59": "0.4619",
"roi_60": "0.4623"
}
]
};}.cls-2{fill:%230868f7;}.cls-3{fill:url(%23未命名的渐变_44);}.cls-4{fill:%23333;}%3c/style%3e%3clinearGradient%20id='未命名的渐变_8'%20x1='33.73'%20y1='100.61'%20x2='-0.03'%20y2='-1.06'%20gradientUnits='userSpaceOnUse'%3e%3cstop%20offset='0'%20stop-color='%237ae9fb'/%3e%3cstop%20offset='0.67'%20stop-color='%232b90f8'/%3e%3cstop%20offset='1'%20stop-color='%230868f7'/%3e%3c/linearGradient%3e%3clinearGradient%20id='未命名的渐变_44'%20x1='27.86'%20y1='18.67'%20x2='68.36'%20y2='22.22'%20gradientUnits='userSpaceOnUse'%3e%3cstop%20offset='0'%20stop-color='%235ac7f2'/%3e%3cstop%20offset='1'%20stop-color='%230868f7'/%3e%3c/linearGradient%3e%3c/defs%3e%3cpath%20class='cls-1'%20d='M29,28.74V81.91l-9.51-3.68v0L8.52,74A7.17,7.17,0,0,1,4,67.32V24.54A3.76,3.76,0,0,1,9.08,21Z'/%3e%3cpath%20class='cls-2'%20d='M68.09,78.07a13.15,13.15,0,0,1-17.9,12.06L29,81.91h0V28.74L50.19,37A13.17,13.17,0,0,0,68.08,25.3h0Z'/%3e%3cpath%20class='cls-3'%20d='M68.08,25.3a13.19,13.19,0,0,1-6.73,10.87A13.09,13.09,0,0,1,50.19,37L29,28.74V6A3.76,3.76,0,0,1,34.1,2.52l25.59,9.91A13.22,13.22,0,0,1,68.08,25.3Z'/%3e%3cpath%20class='cls-4'%20d='M129.06,81.76a4.33,4.33,0,0,1-3.19-1.31,4.4,4.4,0,0,1-1.31-3.24V56.86H97.65V77.21a4.36,4.36,0,0,1-1.35,3.2A4.68,4.68,0,0,1,93,81.76a4.32,4.32,0,0,1-3.19-1.31,4.37,4.37,0,0,1-1.32-3.24V27.27A4.58,4.58,0,0,1,89.83,24a4.59,4.59,0,0,1,7.82,3.27V48.15h26.91V27.27A4.58,4.58,0,0,1,125.91,24a4.59,4.59,0,0,1,7.82,3.27V77.21a4.37,4.37,0,0,1-1.36,3.2A4.65,4.65,0,0,1,129.06,81.76Z'/%3e%3cpath%20class='cls-4'%20d='M163.77,81.66c-6.57,0-11.76-1.92-15.44-5.7s-5.54-9.07-5.54-15.74a26.76,26.76,0,0,1,2.09-10.43,17.72,17.72,0,0,1,6.67-8.06,19.15,19.15,0,0,1,10.68-2.95,19,19,0,0,1,10.46,2.8,18.7,18.7,0,0,1,6.55,7.36,22.53,22.53,0,0,1,2.36,10.28A4.51,4.51,0,0,1,177,63.77H152.23a10.8,10.8,0,0,0,3.49,6.65c2,1.68,4.88,2.52,8.66,2.52a22.25,22.25,0,0,0,7.54-1.21c.74-.3,1.55-.67,2.37-1.07a3.75,3.75,0,0,1,1.84-.4,4.09,4.09,0,0,1,3,1.15,4,4,0,0,1,1.12,3,4.38,4.38,0,0,1-2.58,3.82,32.34,32.34,0,0,1-6.36,2.61A28.67,28.67,0,0,1,163.77,81.66ZM172.4,55.9a9.72,9.72,0,0,0-1.63-4.56A9.9,9.9,0,0,0,167,48a10.38,10.38,0,0,0-4.64-1.14,12,12,0,0,0-4.77,1.06,9.54,9.54,0,0,0-4.89,5.66,11.78,11.78,0,0,0-.51,2.3Z'/%3e%3cpath%20class='cls-4'%20d='M193,81.64a4.49,4.49,0,0,1-4.51-4.55V27.28A4.58,4.58,0,0,1,189.84,24a4.48,4.48,0,0,1,3.28-1.36A4.36,4.36,0,0,1,196.35,24a4.46,4.46,0,0,1,1.31,3.31V77.09a4.34,4.34,0,0,1-1.35,3.2A4.67,4.67,0,0,1,193,81.64Z'/%3e%3cpath%20class='cls-4'%20d='M263.79,81.71a5.7,5.7,0,0,1-4.2-1.74,5.76,5.76,0,0,1-1.73-4.19V27.37a4.58,4.58,0,0,1,1.35-3.27A4.59,4.59,0,0,1,267,27.37V72.53h24a4.58,4.58,0,0,1,3.27,7.82A4.66,4.66,0,0,1,291,81.71Z'/%3e%3cpath%20class='cls-4'%20d='M424.48,81.74a4.71,4.71,0,0,1-2.71-.88,5.43,5.43,0,0,1-1-1l-.07-.09-12.41-17-5.41,5v9.44a4.31,4.31,0,0,1-1.36,3.19,4.66,4.66,0,0,1-3.3,1.36A4.29,4.29,0,0,1,395,80.42a4.36,4.36,0,0,1-1.32-3.23V27.37A4.58,4.58,0,0,1,395,24.1a4.52,4.52,0,0,1,6.58.12,4.54,4.54,0,0,1,1.24,3.15V56.31l17.72-16.38.05,0a4.8,4.8,0,0,1,2.94-1.11,4.4,4.4,0,0,1,3.27,1.2,4.57,4.57,0,0,1,1.2,3.27,4.44,4.44,0,0,1-.77,2.33,7.45,7.45,0,0,1-1.43,1.65l-11,9.64,13.34,17.68a5,5,0,0,1,1,2.71,4.12,4.12,0,0,1-1.36,3.24A4.64,4.64,0,0,1,424.48,81.74Z'/%3e%3cpath%20class='cls-4'%20d='M317.93,81.76a21.5,21.5,0,1,1,21.17-21.5A21.37,21.37,0,0,1,317.93,81.76Zm0-34.1a12.61,12.61,0,1,0,12.42,12.6A12.52,12.52,0,0,0,317.93,47.66Z'/%3e%3cpath%20class='cls-4'%20d='M212.18,101.22a4.12,4.12,0,0,1-3.05-1.26,4.17,4.17,0,0,1-1.26-3.1V43.34a4.37,4.37,0,0,1,1.3-3.14,4.26,4.26,0,0,1,3.13-1.3,4.19,4.19,0,0,1,3.1,1.26,4.32,4.32,0,0,1,1.26,3.16,20.77,20.77,0,0,1,13-4.54,21.51,21.51,0,0,1,0,43,20.51,20.51,0,0,1-13-4.57V96.86a4.15,4.15,0,0,1-1.3,3.06A4.5,4.5,0,0,1,212.18,101.22Zm17.43-53.63c-6.23,0-12.93,4.11-12.93,12.72a12.73,12.73,0,0,0,25.46,0A12.71,12.71,0,0,0,229.61,47.59Z'/%3e%3cpath%20class='cls-4'%20d='M365.76,81.76a21.5,21.5,0,1,1,21.18-21.5A21.37,21.37,0,0,1,365.76,81.76Zm0-34.1a12.61,12.61,0,1,0,12.42,12.6A12.52,12.52,0,0,0,365.76,47.66Z'/%3e%3c/svg%3e)