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. |
| impression_value |
Numeric |
Number of impressions. |
| advertise_cost |
Numeric |
Revenue. |
Sample JSON
{
"alert": null,
"records": [
{
"report_date": "20220101",
"impression_value": 12345,
"advertise_cost": 123.123456
}
]
}
HTTP Status Codes
The table below lists common HTTP status codes sent in REST API responses from the Adpopcorn API platform.