Impression And Click Device Report

Note: Before integrating the API, Please familiarize yourself with the API signature mechanism first (refer to the Authentication), which is the source of some http request headers in the API request sample. Here are authentication demos for different development languages:  Authentication Demo

Note:

• Data generation is supported starting from the time Hyperbid grants operational permissions (for example, if the permissions are opened on the 1st, data can be retrieved as early as the 2nd. For specific times, please refer to the update time of the data in each time zone for the advance tasks below), and only the data for the most recent 30 days is retained. The returned content is provided in the form of a file. If the data is not obtained at that time, please try again the next day. Note: Hyperbid will execute the task of generating data for each time zone twice a day, once as an advance task and once as a backup task. The revenue data of the advance task may not be complete (the determining factor is that different advertising platforms have different report data release times, and some advertising platforms may not have released report data at the time of the advance task). Developers can pull the data after the backup task again as needed.
• the data update time of each time zone for the first task:

1. UTC + 8: delayed 1 day, update at 11:30 pm (UTC + 8)
2. UTC + 0: delayed by 1 day, updated at 5:30 pm (UTC + 8)
3. UTC - 8: delayed by 2 days, updated at 1:30 am (UTC + 8)

• the data update time of each time zone for the second task:

1. UTC + 8: delayed 2 days, update at 4 am (UTC + 8)
2. UTC + 0: delayed by 2 days, updated at 12 am (UTC + 8)
3. UTC - 8: delayed by 3 days, updated at 4 am (UTC + 8)

1 Request URL

https://openapi.hyperbid.com/v1/device/report

2 Request method

GET

3 Request param

params	type	required	notes	sample
day	Int	Y	start date, format：YYYYmmdd	20190501,Earliest date is yesterday
app_id	String	Y	Hyperbid APP ID(single)	xxxxx
timezone	Int	N	Time Zone	-8 or 8 or 0

request sample：

curl --location --request GET 'https://openapi.hyperbid.com/v1/device/report?app_id=a606c22b789bc3&day=20210823&timezone=8' \
--header 'X-Up-Key: fadcf18aa7805522b1cbbf847f20a9fd871aa902' \
--header 'X-Up-Signature: E3BDAB211713C0CFEDDB249121524123' \
--header 'X-Up-Timestamp: 1623744546000'

4 Response data

This interface returns the download link for the report data. After obtaining the link, developers can directly download the report data in their browser. The link format is as follows:
https://topon-openapi.s3.amazonaws.com/topon_report_device/dt%3D2019-07-10/publisher_id%3D22/app_id%3Da5d147334b3685/000000_0?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA35FGARBHLHHS7TWB%2F20190828%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20190828T095315Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=6aaf947f9b2cf02f3acb49d64a3daf719cb0b57a3d5221b0121a006e58b04b10

The data is provided in CSV format, using a comma (",") as the delimiter. The specific parameter details are as follows:

params	field	notes
placement  id	placement_id
placement name	placement_name
placement format	placement_format	0: native 1: rewarded_video 2: banner, 3: interstitial 4: splash
unit id	unit_id
Google gaid	gaid
iOS device idfa	idfa
country	area
is_abtest	is_abtest	0: Control group or A/B test not enabled 1: Test group
abtest_item_id	abtest_item_id
segment_id	segment_id
segment_name	segment_name
iOS idfv	idfv
oaid	oaid
user_id	user_id
network_firm_id	network_firm_id
network_firm	network_firm
mediation id	mediation_id
mediation name	mediation_name
currency	currency
os version	os_version
att status	att_status	Undetermined: The developer has not yet requested user permission. Restricted: The user can opt out of IDFA for all apps at the device level. Denied: The user has opted out of IDFA. Authorized: IDFA collection can continue. Undetermined: The user has disabled IDFA upload via DeniedUploadInfo.
device type	device_type	Explanation of Enumeration Values: 0: Non-iOS Device 1: iPhone 2: iPad
brand	brand
model	model
app_vn	app_vn	app version name
app_vc	app_vc	app version
new_user_type	new_user_type	1: new user 2: not new user
channel	channel
impression	impression
click	click
estimated_revenue	estimated_revenue	Estimated Revenue: The estimated revenue returned in the currency of the developer's account.