Request
Request Headers
Header Name |
Type |
Value |
Required |
Description |
Authorization |
String |
Bearer ${access_token} |
Yes |
Send your generated access token in place of ${access_token} for authorization. |
Example: |
|
|
|
|
curl “https://sspi-ext-report.adpopcorn.com/v1/analytics/data?fromDate=20220101&toDate=20220101” -H “Authorization: Bearer test_access_token” -L |
Request Query Parameters
The following table lists parameters you can use to build requests.
Parameter Name |
Type |
Required |
Description |
fromDate |
String |
Yes |
Start date of data retrieval. Example: 20220101 |
toDate |
String |
Yes |
End date of data retrieval. Example: 20220101 |
Response
Header Name |
Type |
Description |
Content-Type |
application/json |
JSON response |
Response Body Parameters
The following table lists parameters returns in API responses.
Body Parameter |
Type |
Description |
alert |
String |
Alert message from server. In most cases, it will be null, Example: “alert”: null |
records |
Array of object |
The main table-like data structure |
ID |
Type |
Description |
report_date |
String |
Date (YYYYMMDD format) on which an impression was requested. |
campaign_id |
String |
Unique id of the ad campaign |
campaign_name |
String |
Campaign name |
adset_id |
String |
Unique id of the adset |
adset_name |
String |
Adset name |
custom_id |
String |
Custom id of campaign [only provided when use custom id] |
impression |
Numeric |
Number of impressions. |
click |
Numeric |
Number of clicks. |
adv_price |
Numeric |
Revenue. |
Sample JSON
{
"alert": null,
"records": [
{
"report_date": "20230601",
"campaign_id": "c16850882834534z",
"campaign_name": "인하우스",
"adset_id": "s16850884077be4q",
"adset_name": "카드",
"impression": 3894,
"click": 18,
"adv_price": 3894
}
]
}
HTTP Status Codes
The table below lists common HTTP status codes sent in REST API responses from the Adpopcorn API platform.