Note: Please be familiar with the API signature mechanism before accessing the API (refer to the API authentication description), that is, the source of some HTTP request headers in the API request sample.
1.Request URL
https://openapi.hyperbid.com/v1/report/full
2.Request method
POST
3.Request Parameters
| param | type | required | note | sample |
|---|---|---|---|---|
|
time_zone |
String |
Y | Timezone, enumeration value: UTC-8, UTC+8, UTC+0 | "UTC+8" |
|
start_date |
Int |
Y | Start date, format: YYYYmmdd | 20250801 |
|
end_date |
Int |
Y | End date, format: YYYYmmdd | 20250801 |
|
app_id_list |
Array[String] |
N |
A list of multiple Mediation Application IDs in the developer backend, maximum query 100 |
["ja547b671dc3ef29"] |
|
placement_id_list |
Array[String] |
N |
A list of multiple Mediation Unit IDs in the developer backend, maximum query 100 |
["kde0e6953d508fee"] |
|
segment_id_list |
Array[Int] |
N |
A list of multiple Traffic Group IDs in the developer backend, maximum query 100 |
[300000126] |
|
unit_id_list |
Array[Int] |
N |
A list of multiple Ad Unit IDs in the developer backend, maximum query 100 |
[300000268] |
|
abtest_item_id_list |
Array[Int] |
N |
A list of multiple A/B Test Item IDs in the developer backend, maximum query 100 |
[300000025] |
|
channel_list |
Array[Int] |
N |
A list of multiple Channel Names in the developer backend, maximum query 100 |
["MyChannel"] |
|
geo_short_list |
Array[String] |
N |
Country short code list, default is all countries, maximum query 100 |
["US","CN"] |
|
nw_firm_id_list |
Array[Int] |
N |
Network firm id list |
[1,2] |
|
mm_firm_id_list |
Array[Int] |
N |
Mediation firm id list |
[1,2] |
|
format_list |
Array[Int] |
N |
Ad Format list, enumeration value: |
[0,1,2] |
|
sdk_version_list |
Array[String] |
N |
SDK version list, maximum query 100 |
["1.0.0"] |
|
app_version_list |
Array[String] |
N |
Application version list, maximum query 100 |
["5.0.0"] |
|
platform_list |
Array[Int] |
N |
System platform list, enumeration value: 1: Android |
[1,2] |
|
idfa_status_list |
Array[Int] |
N |
IDFA status list, enumeration value: 1: With IDFA |
[1] |
|
user_type_list |
Array[Int] |
N |
User type list, enumeration value: 1: New user |
[1] |
|
is_ps |
Int |
N | SDK Preset Strategy, enumeration value: 1：Yes 2：No |
2 |
|
metric |
Array[String] |
N |
When both “all” and other metrics are selected, all metrics are returned: default (Default Metrics: dau, aipau, engaged_rate, estimated_revenue, estimated_revenue_ecpm, estimated_revenue_arpu, load, load_filled_rate, request, request_filled_rate, impression, impression_rate, click, ctr), dau_launch (Launch DAU), deu (DEU), engaged_rate (Engaged Rate), aipau (Imp. /DAU), aipu (Imp. /DEU), new_user (New Users), new_user_rate (New Users/DAU), estimated_revenue (Estimated Revenue), estimated_revenue_arpu (Estimated ARPDAU), estimated_revenue_ecpm (Est. eCPM), estimated_revenue_rate (Estimated Revenue Proportion), bid_total (Participation in Price Comparison), bid_request_rate (Price Comparison Participation Rate), bid_win_rate (Price Comparison Winning Rate), bid_ecpm (Price Comparison eCPM), bid_win (Victory In Price Comparison), load (Mediation Unit Requests), load_filled_rate (Mediation Unit Request Fill Rate), request (Ad Unit Attempt), request_filled_rate (Ad Unit Attempt Fill Rate), impression (Impression), impression_rate (Impression Rate), click (Click), ctr (Click Rate), request_cost_time (Latency), sdk_impression_rate (Impression Proportion), click_rate (Click Proportion), ready_request (isReady), ready_success_rate (isReady Rate), revenue_gap (Revenue Gap), ecpm_gap (eCPM Gap), impression_gap (Impression Gap), click_gap (Click Gap), unit_request (Attempt API), unit_filled_rate (Attempt Fill Rate API), unit_impression (Impression API), unit_click (Click API), unit_ctr (CTR API), unit_impression_rate (Impression API Proportion), unit_click_rate (Click API Proportion), arpu (ARPDAU API), unit_revenue (Revenue API), unit_ecpm (eCPM API), unit_revenue_rate (Revenue API Proportion) |
["dau","deu"] |
|
group_by |
Array[String] |
N |
Filter dimension list. The supported dimensions are as follows: date_time (Date, default), app_id (Application), placement_id (Mediation Unit), segment_id (Traffic Group), unit_id (Ad Unit), abtest_item_id (A/B Test Item), format (Ad Format), nw_firm_id (Network Firm), mm_firm_id (Mediation Firm), geo_short (Country), channel (Channel), sdk_version(SDK Version), app_version(Application Version), idfa (IDFA Status), platform (System Platform), user_type (User Type) |
["date_time","user_type"] |
|
order_by |
Array[Array[String][2]] |
N |
Metric sorting, supports the following metrics: request, impression, click, dau, deu, estimated_revenue, unit_request, unit_impression, unit_click, unit_revenue, load, new_user, dau_launch, request_filled_rate, load_filled_rate, ctr, ecpm, new_user_rate, arpu, engaged_rate, aipu, aipau, unit_filled_rate, impression_rate, unit_ctr, unit_ecpm, unit_ecpr, impression_gap, click_gap, estimated_revenue_ecpm, ready_success_rate, estimated_revenue_arpu, revenue_gap, ecpm_gap, request_cost_time, bid_request_rate, bid_total, impression_rate, bid_ecpm, bid_win, unit_revenue_rate, unit_impression_rate, unit_click_rate, sdk_impression_rate, click_rate, estimated_revenue_rate, ready_request Supported sorting methods: asc (Ascending order) desc (Descending order) |
[["dau","desc"]] |
| start | Int | N | The offset number indicates the starting point of the data. The default value is 0. | 0 |
| limit | Int | N | The maximum number of data to be pulled each time, the default is 1000, optional [1,1000] | 10 |
4.Return Parameters
| param | type | required | note |
| 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 | Total number of entries, empty if no data is availabletime_zone |
| time_zone | String | N | Time zone, enumeration value: UTC-8, UTC+8, UTC+0 |
| currency | String | N | The currency of the developer account |
The records element structure is as follows:
| param | type | required | note |
|---|---|---|---|
| date_time | String | N | Date, format: YYYYmmdd. Only returned if date_time is selected in group_by |
| app_id | String | N | The Application ID of the developer backend. This is returned only when the app_id dimension is selected in group_by. |
| placement_id | String | N |
The Mediation Unit ID of the developer backend. This is returned only when the placement_id dimension is selected in group_by. |
| segment_id | Int | N |
The Traffic Group ID of the developer backend. This is returned only when the segment_id dimension is selected in group_by. |
| unit_id | Int | N |
The Ad Unit ID of the developer backend. This is returned only when the unit_id dimension is selected in group_by. |
| abtest_item_id | Int | N |
The A/B Test Item ID of the developer backend. This is returned only when the abtest_item_id dimension is selected in group_by. |
| format | Int | N | Ad format, group_by returns only when the format dimension is selected. Enumeration values: 0: Native 1: Rewarded Video 2: Banner 3: Interstitial 4: Splash |
| geo_short | String | N | Country code. Returned only when geo_short dimension is selected in group_by |
| mm_firm_id | Int | N | Mediation Firm ID. This is returned only when the mm_firm_id dimension is selected in group_by. |
| nw_firm_id | Int | N | Network Firm ID. This is returned only when the nw_firm_id dimension is selected in group_by. |
| platform | Int | N |
System Platform. This is returned only when the platform dimension is selected in group_by. Enumeration values: 1: Android |
| sdk_version | String | N |
SDK Version. This is returned only when the sdk_version dimension is selected in group_by. |
| app_version | String | N |
Application Version. This is returned only when the app_version dimension is selected in group_by. |
| channel | String | N |
Channel. This is returned only when the channel dimension is selected in group_by. |
| idfa_status | Int | N |
IDFA Status. This is returned only when the idfa dimension is selected in group_by. Enumeration value: 1: With IDFA |
| user_type | Int | N |
User Type. This is returned only when the user_type dimension is selected in group_by. Enumeration value: 1: New user |
| dau | Int | N | DAU. Note: If some group_by dimensions (e.g. is_ps) are selected, DAU metric will not be returned in the response. |
| dau_launch | Int | N |
Launch DAU. Note: If some group_by dimensions (e.g. segment_id, unit_id, nw_firm_id, format, sdk_version, app_version) are selected, this metric will not be returned in the response. |
| deu | Int | N | DEU. Note: If some group_by dimensions (e.g. is_ps) are selected, DEU metric will not be returned in the response. |
| engaged_rate | Float | N |
Engaged Rate |
| aipau | Float | N | Imp. /DAU |
| aipu | Float | N | Imp. /DEU |
| new_user | Int | N |
New Users. Note: If some group_by dimensions (e.g. segment_id, unit_id, nw_firm_id, format, sdk_version, app_version, idfa) are selected, this metric will not be returned in the response. |
| new_user_rate | Float | N |
New Users/DAU |
| estimated_revenue | Float | N |
Estimate Revenue. The estimate revenue, returned according to the developer account currency |
| estimated_revenue_arpu | Float | N |
Estimate ARPDAU, this item is returned only if there is dau |
| estimated_revenue_ecpm | Float | N |
Estimate eCPM |
| estimated_revenue_rate | Float | N |
Estimate Revenue Proportion |
| bid_total | Int | N |
Participation in Price Comparison. Note: If some group_by dimensions (e.g. nw_firm_id) are selected, this metric will not be returned in the response. |
| bid_request_rate | Float | N |
Price Comparison Participation Rate. Note: If some group_by dimensions (e.g. nw_firm_id) are selected, this metric will not be returned in the response. |
| bid_win_rate | Float | N |
Price Comparison Winning Rate. Note: If some group_by dimensions (e.g. placement_id, unit_id) are selected, this metric will returned in the response. |
| bid_ecpm | Float | N |
Price Comparison eCPM |
| bid_win | Int | N | Victory In Price Comparison |
| load | Int | N |
Mediation Unit Requests. Note: If some group_by dimensions (e.g. unit_id, nw_firm_id, mm_firm_id) are selected, this metric will not be returned in the response. |
| load_filled_rate | Float | N |
Mediation Unit Request Fill Rate. Note: If some group_by dimensions (e.g. unit_id, nw_firm_id, mm_firm_id) are selected, this metric will not be returned in the response. |
| request | Int | N |
Ad Unit Attempt. Note: If some group_by dimensions (e.g. nw_firm_id) are selected, this metric will not be returned in the response. |
| request_filled_rate | Float | N |
Ad Unit Attempt Fill Rate. Note: If some group_by dimensions (e.g. nw_firm_id) are selected, this metric will not be returned in the response. |
| impression | Int | N | Impression |
| impression_rate | Float | N | Impression Rate |
| click | Int | N | Click |
| ctr | Float | N | Click Rate |
| request_cost_time | Int | N |
Latency(ms.) |
| click_rate | Float | N |
Click Proportion |
| sdk_impression_rate | Float | N |
Impression Proportion |
| ready_request | Int | N |
isReady. Note: If some group_by dimensions (e.g. unit_id, nw_firm_id, mm_firm_id) are selected, isReady metric will not be returned in the response. |
| ready_success_rate | Float | N | isReady Rate. |
| revenue_gap | Float | N |
Revenue Gap. Note: If some group_by dimensions (e.g. segment_id, channel, sdk_version, app_version, user_type, idfa, is_ps) are selected, Gap metric will not be returned in the response. |
| ecpm_gap | Float | N | eCPM Gap |
| impression_gap | Float | N | Impression Gap |
| click_gap | Float | N | Click Gap |
| unit_request | Int | N |
Attempts API. Note: If some group_by dimensions (e.g. segment_id, sdk_version, app_version, channel, idfa, user_type, is_ps) are selected, API metric will not be returned in the response. Select the nw_firm_id dimension does not return this metric. |
| unit_filled_rate | Float | N |
Attempts Fill Rate API. Note: Select the nw_firm_id dimension does not return this metric. |
| unit_impression | Int | N | Impression API |
| unit_click | Int | N | Click API |
| unit_ctr | Float | N | Click Rate API |
| unit_click_rate | Float | N | Click API Proportion |
| unit_impression_rate | Float | N | Impression API Proportion |
| arpu | Float | N | ARPDAU, Note: If some group_by dimensions (e.g. nw_firm_id) are selected, this metric will not be returned in the response. |
| unit_revenue | Float | N | Revenue API |
| unit_ecpm | Float | N | eCPM API |
| unit_revenue_rate | Float | N | Revenue API Proportion |
5.Examples
Request Sample:
curl --location --request POST 'https://openapi.hyperbid.com/v1/report/full' \
--header 'X-Up-Key: a5c20012d6964913dcea19dbb09243282518505c' \
--header 'X-Up-Signature: CE12B506DBCD868C2C6F09E08C139CBC' \
--header 'X-Up-Timestamp: 1754033553000' \
--header 'Content-Type: application/json' \
--data-raw '{
"start_date": 20250801,
"end_date": 20250801,
"group_by":["date_time"],
"start": 0,
"limit": 30,
"time_zone": "UTC+8",
"app_id_list":["ja547b671dc3ef29"]
}'Response Example:
{
"count": 1,
"time_zone": "UTC+8",
"currency": "USD",
"records": [
{
"date_time": 20250801,
"dau": 279,
"aipau": 1.2043,
"engaged_rate": 0.301,
"estimated_revenue": 0.608784,
"estimated_revenue_ecpm": 1.81,
"estimated_revenue_arpu": 0.0021,
"load": 1817,
"load_filled_rate": 0.3307,
"request": 4529,
"request_filled_rate": 0.2525,
"impression": 336,
"click": 53,
"ctr": 0.1577
}
]
};}.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)