Help centerHourly Report API
WARNING
An authentication token is required when calling this API. See Token Usage Guide for details.
Request URL
https://scaler.taurusx.com/openapi/report_hourly
Request Method
GET
Request Parameters
| Field | Required | Type | Description | Default | Example |
|---|---|---|---|---|---|
| timezone | No | string | Timezone for the data | 0 | 0 |
| report_type | No | string | Type of report, see explanation below | event | event |
| start_time | Yes | string | Start date in the format "yyyy-MM-dd", supports querying the past 7 days | — | "2023-04-23" |
| end_time | Yes | string | End date in the format "yyyy-MM-dd", supports querying the past 7 days | — | "2023-04-27" |
Report Type Explanation
event: Statistics based on event timerequest: Statistics based on report generation time
Response Field Descriptions
| Name | Parent | Type | Description |
|---|---|---|---|
| code | — | int | 200 indicates success; other values indicate failure |
| data | — | json | Result object |
| data_list | data | array<json> | List of report records |
| creative_id | data_list | string | Creative ID |
| date | data_list | string | Timestamp in format "2023-04-27 08:00:00" |
| country | data_list | string | Country (2-letter ISO code) |
| impressions | data_list | number | Number of impressions |
| clicks | data_list | number | Number of clicks |
| conversions | data_list | number | Number of conversions |
| cost | data_list | number | Cost in USD |
Example Response
json
{
"code": 200,
"data": {
"data_list": [
{
"creative_id": 10001173,
"date": "2023-10-10 07:00:00",
"country": "IN",
"clicks": 2,
"conversions": 0,
"cost": 3.008888636713743034,
"impressions": 116
}
]
},
"msg": "ok"
}{
"code": 200,
"data": {
"data_list": [
{
"creative_id": 10001173,
"date": "2023-10-10 07:00:00",
"country": "IN",
"clicks": 2,
"conversions": 0,
"cost": 3.008888636713743034,
"impressions": 116
}
]
},
"msg": "ok"
}