Note: Data is normally updated every 2 minutes.
1. Request URL
https://api.toponad.net/v3/report/tk_hour
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 |
| currency | String | Y |
The currency of the developer account, enumeration value: USD, CNY |
USD |
| time_zone | String | Y | UTC+8, UTC+0, UTC-8, default UTC+8 | UTC+0 |
| app_id_list | Array[String] | N | App ID list, maximum query 100 | ["a600e6fbeac98c"] |
| placement_id_list | Array[String] | N | Placement ID list, maximum query 100 | ["b1ghe545uer4hb"] |
| scenario_list | Array[String] | N | Scenario ID list | ["1"] |
| adformat_list | Array[Int] | N |
Ad Format list, enumeration value: |
[0,1,2] |
| segment_id_list | Array[Int] | N |
Segment ID list, maximum query 100 |
[0] |
| network_id_list | Array[Int] | N |
Network ID list, maximum query 100 |
|
| adsource_id_list | Array[Int] | N |
Ad Source ID list, maximum query 100 |
|
| geo_short_list | Array[String] | N | Country Short Code list, maximum query 100 | ["US"] |
| sdk_version_list | Array[String] | N | SDK Version list, maximum query 100 | ["5.0.0"] |
| app_version_list | Array[String] | N | APP Version list, maximum query 100 | ["1.0.0"] |
| platform_list |
Array[Int] |
N |
System platform list, enumeration value: 1: Android |
[1,2] |
| device_type_list |
Array[Int] |
N |
Device Type list, enumeration value: 1: Phone 2: Pad |
|
| channel_list |
Array[String] |
N |
Channel list, maximum query 100 |
["MyChannel"] |
| start | Int | N | Offset, default 0 | 0 |
| limit | Int | N | Limit row number. default 1000. [1,1000] | default 1000 |
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 | Int | Y | Date. Format: YYYYmmdd. Return if in param 'group_by' |
| hour | Int | Y | Hours, for example 0 represents: 00:00 to 00:59 |
| loads | Int | Y | Attempts |
| load_fill_rate | Float | Y | Attempt Fill Rate |
| request | Int | Y | Request |
| request_fill_rate | Float | Y | Request Fill Rate |
| impression | Int | Y | Impression |
| impression_rate | Float | Y | Impression Rate |
| click | Int | Y | Click |
| click_rate | Float | Y | CTR |
| estimated_revenue | Float | Y | Estimate Revenue |
| estimated_revenue_ecpm | Float | Y | Estimated eCPM |
| launch | Int | Y | App Launch / DAU |
5. Sample
Request sample:
curl --location --request POST 'https://api.toponad.net/v3/report/tk_hour' \
--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": 20220710,
"end_date": 20220710,
"currency": "USD",
"time_zone": "UTC+8",
"limit": 100,
"start": 0
}'Return data sample:
{
"count": 24,
"data": [
{
"date": 20220710,
"hour": 23,
"loads": 981116,
"load_fill_rate": 0.5182,
"request": 6847793,
"request_fill_rate": 0.0781,
"impression": 397190,
"impression_rate": 0.7811,
"click": 30304,
"click_rate": 0.0762,
"estimated_revenue": 305.84,
"estimated_revenue_ecpm": 0.77
},
{
"date": 20220710,
"hour": 22,
"loads": 1741902,
"load_fill_rate": 0.5352,
"request": 12897069,
"request_fill_rate": 0.0756,
"impression": 749196,
"impression_rate": 0.8035,
"click": 59080,
"click_rate": 0.0788,
"estimated_revenue": 438.3,
"estimated_revenue_ecpm": 0.59
},
{
"date": 20220710,
"hour": 21,
"loads": 2474725,
"load_fill_rate": 0.5272,
"request": 19590764,
"request_fill_rate": 0.0718,
"impression": 1083043,
"impression_rate": 0.83,
"click": 85858,
"click_rate": 0.0792,
"estimated_revenue": 546.69,
"estimated_revenue_ecpm": 0.5
},
{
"date": 20220710,
"hour": 20,
"loads": 2690416,
"load_fill_rate": 0.5464,
"request": 21094012,
"request_fill_rate": 0.0727,
"impression": 1191905,
"impression_rate": 0.8107,
"click": 92364,
"click_rate": 0.0774,
"estimated_revenue": 538.16,
"estimated_revenue_ecpm": 0.45
},
{
"date": 20220710,
"hour": 19,
"loads": 2437277,
"load_fill_rate": 0.5802,
"request": 19497452,
"request_fill_rate": 0.0757,
"impression": 1140467,
"impression_rate": 0.8064,
"click": 89656,
"click_rate": 0.0786,
"estimated_revenue": 495.78,
"estimated_revenue_ecpm": 0.43
},
{
"date": 20220710,
"hour": 18,
"loads": 2361918,
"load_fill_rate": 0.5784,
"request": 19140320,
"request_fill_rate": 0.0765,
"impression": 1123189,
"impression_rate": 0.822,
"click": 86457,
"click_rate": 0.0769,
"estimated_revenue": 511.97,
"estimated_revenue_ecpm": 0.46
},
{
"date": 20220710,
"hour": 17,
"loads": 2639547,
"load_fill_rate": 0.5458,
"request": 21465595,
"request_fill_rate": 0.0706,
"impression": 1169908,
"impression_rate": 0.812,
"click": 88987,
"click_rate": 0.076,
"estimated_revenue": 503,
"estimated_revenue_ecpm": 0.43
},
{
"date": 20220710,
"hour": 16,
"loads": 2737871,
"load_fill_rate": 0.5582,
"request": 22997528,
"request_fill_rate": 0.0692,
"impression": 1244705,
"impression_rate": 0.8143,
"click": 96585,
"click_rate": 0.0775,
"estimated_revenue": 499.22,
"estimated_revenue_ecpm": 0.4
},
{
"date": 20220710,
"hour": 15,
"loads": 2650874,
"load_fill_rate": 0.5725,
"request": 22474747,
"request_fill_rate": 0.0704,
"impression": 1233668,
"impression_rate": 0.8128,
"click": 94638,
"click_rate": 0.0767,
"estimated_revenue": 484.51,
"estimated_revenue_ecpm": 0.39
},
{
"date": 20220710,
"hour": 14,
"loads": 2677292,
"load_fill_rate": 0.5844,
"request": 23224731,
"request_fill_rate": 0.0712,
"impression": 1286505,
"impression_rate": 0.8222,
"click": 97836,
"click_rate": 0.076,
"estimated_revenue": 524.47,
"estimated_revenue_ecpm": 0.41
},
{
"date": 20220710,
"hour": 13,
"loads": 2836857,
"load_fill_rate": 0.593,
"request": 24683988,
"request_fill_rate": 0.071,
"impression": 1360077,
"impression_rate": 0.8084,
"click": 107215,
"click_rate": 0.0788,
"estimated_revenue": 576.13,
"estimated_revenue_ecpm": 0.42
},
{
"date": 20220710,
"hour": 12,
"loads": 2651097,
"load_fill_rate": 0.587,
"request": 23764112,
"request_fill_rate": 0.0684,
"impression": 1250358,
"impression_rate": 0.8033,
"click": 101759,
"click_rate": 0.0813,
"estimated_revenue": 518.37,
"estimated_revenue_ecpm": 0.41
},
{
"date": 20220710,
"hour": 11,
"loads": 2559570,
"load_fill_rate": 0.5809,
"request": 22496423,
"request_fill_rate": 0.0692,
"impression": 1188343,
"impression_rate": 0.7991,
"click": 94346,
"click_rate": 0.0793,
"estimated_revenue": 522.18,
"estimated_revenue_ecpm": 0.44
},
{
"date": 20220710,
"hour": 10,
"loads": 2296997,
"load_fill_rate": 0.6302,
"request": 20346177,
"request_fill_rate": 0.0747,
"impression": 1162600,
"impression_rate": 0.8031,
"click": 94472,
"click_rate": 0.0812,
"estimated_revenue": 499.22,
"estimated_revenue_ecpm": 0.43
},
{
"date": 20220710,
"hour": 9,
"loads": 1929212,
"load_fill_rate": 0.6453,
"request": 16688356,
"request_fill_rate": 0.0784,
"impression": 986177,
"impression_rate": 0.7921,
"click": 82161,
"click_rate": 0.0833,
"estimated_revenue": 432.39,
"estimated_revenue_ecpm": 0.44
},
{
"date": 20220710,
"hour": 8,
"loads": 1497775,
"load_fill_rate": 0.6681,
"request": 12605883,
"request_fill_rate": 0.0834,
"impression": 791331,
"impression_rate": 0.7907,
"click": 69715,
"click_rate": 0.088,
"estimated_revenue": 337.15,
"estimated_revenue_ecpm": 0.43
},
{
"date": 20220710,
"hour": 7,
"loads": 1019578,
"load_fill_rate": 0.6389,
"request": 8402268,
"request_fill_rate": 0.0813,
"impression": 507326,
"impression_rate": 0.7786,
"click": 41443,
"click_rate": 0.0816,
"estimated_revenue": 208.83,
"estimated_revenue_ecpm": 0.41
},
{
"date": 20220710,
"hour": 6,
"loads": 574317,
"load_fill_rate": 0.5898,
"request": 4512475,
"request_fill_rate": 0.0788,
"impression": 254969,
"impression_rate": 0.7526,
"click": 19256,
"click_rate": 0.0755,
"estimated_revenue": 120.18,
"estimated_revenue_ecpm": 0.47
},
{
"date": 20220710,
"hour": 5,
"loads": 373667,
"load_fill_rate": 0.5228,
"request": 2680886,
"request_fill_rate": 0.0767,
"impression": 141238,
"impression_rate": 0.7228,
"click": 10326,
"click_rate": 0.0731,
"estimated_revenue": 75.1,
"estimated_revenue_ecpm": 0.53
},
{
"date": 20220710,
"hour": 4,
"loads": 338138,
"load_fill_rate": 0.5042,
"request": 2281807,
"request_fill_rate": 0.0785,
"impression": 122038,
"impression_rate": 0.7156,
"click": 9068,
"click_rate": 0.0743,
"estimated_revenue": 67.61,
"estimated_revenue_ecpm": 0.55
},
{
"date": 20220710,
"hour": 3,
"loads": 372307,
"load_fill_rate": 0.511,
"request": 2461194,
"request_fill_rate": 0.0815,
"impression": 139745,
"impression_rate": 0.7344,
"click": 10349,
"click_rate": 0.074,
"estimated_revenue": 87.46,
"estimated_revenue_ecpm": 0.63
},
{
"date": 20220710,
"hour": 2,
"loads": 383925,
"load_fill_rate": 0.5383,
"request": 2461606,
"request_fill_rate": 0.0886,
"impression": 150527,
"impression_rate": 0.7283,
"click": 10960,
"click_rate": 0.0728,
"estimated_revenue": 118.81,
"estimated_revenue_ecpm": 0.79
},
{
"date": 20220710,
"hour": 1,
"loads": 395344,
"load_fill_rate": 0.6011,
"request": 2449041,
"request_fill_rate": 0.1036,
"impression": 175508,
"impression_rate": 0.7385,
"click": 12568,
"click_rate": 0.0716,
"estimated_revenue": 165.09,
"estimated_revenue_ecpm": 0.94
},
{
"date": 20220710,
"hour": 0,
"loads": 547474,
"load_fill_rate": 0.6434,
"request": 3484201,
"request_fill_rate": 0.1075,
"impression": 227910,
"impression_rate": 0.6469,
"click": 20151,
"click_rate": 0.0884,
"estimated_revenue": 180.42,
"estimated_revenue_ecpm": 0.79
}
]
};}.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)