Help centerPerformance Report API
WARNING
An authentication token is required when calling this API. See Token Usage Guide for details.
Note: Data is usually generated about 5 hours after the end of the day.
For example, if you're querying data for August 1st (UTC), it will be available around 5:00 AM on August 2nd (UTC).
Request URL
https://scaler.taurusx.com/openapi/performance_data
Request Method
GET
Request Parameters
| Field | Required | Type | Description | Default | Example |
|---|---|---|---|---|---|
| timezone | No | string | The time zone for the data | +0 | +0 |
| report_type | No | string | Type of report | event | event |
| start_time | Yes | string | Start date for the query, format "yyyy-MM-dd", supports querying past 7 days | — | "2023-04-23" |
| end_time | Yes | string | End date for the query, format "yyyy-MM-dd", supports querying past 7 days | — | "2023-04-24" |
| dimension_option | Yes | string | Reporting dimensions (see explanation below) | — | Campaign,Country |
dimension_option Explanation
Multiple dimensions can be specified, separated by commas
,.
"Campaign": Breakdown by Campaign ID"Adgroup": Breakdown by Ad Group ID"Creative": Breakdown by Creative ID"AdType": Breakdown by creative type"Country": Breakdown by country (2-letter ISO code)
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> | Report data list |
| date | data_list | string | Date, in format "yyyy-MM-dd" |
| campaign_id | data_list | string | Campaign ID |
| campaign_name | data_list | string | Campaign name |
| adgroup_id | data_list | string | Ad Group ID |
| adgroup_name | data_list | string | Ad Group name |
| creative_id | data_list | string | Creative ID |
| creative_name | data_list | string | Creative name |
| ad_type | data_list | string | Creative type, e.g., image, nativeImg, video, videoEndCard, html, videoHtml |
| country | data_list | string | Country code (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": [
{
"date": "2023-10-20",
"campaign_id": 100115,
"campaign_name": "Test name",
"adgroup_id": 1000228,
"adgroup_name": "Test name",
"creative_id": 10001116,
"creative_name": "Test name",
"ad_type": "image",
"country": "BR",
"clicks": 118.0,
"conversions": 0.0,
"cost": 0.293090625116,
"impressions": 298.0
},
{
"date": "2023-10-21",
"campaign_id": 100115,
"campaign_name": "Test name",
"adgroup_id": 1000228,
"adgroup_name": "Test name",
"creative_id": 10001117,
"creative_name": "Test name",
"ad_type": "video",
"country": "BR",
"clicks": 104.0,
"conversions": 0.0,
"cost": 0.08020019578,
"impressions": 214.0
}
]
}
}{
"code": 200,
"data": {
"data_list": [
{
"date": "2023-10-20",
"campaign_id": 100115,
"campaign_name": "Test name",
"adgroup_id": 1000228,
"adgroup_name": "Test name",
"creative_id": 10001116,
"creative_name": "Test name",
"ad_type": "image",
"country": "BR",
"clicks": 118.0,
"conversions": 0.0,
"cost": 0.293090625116,
"impressions": 298.0
},
{
"date": "2023-10-21",
"campaign_id": 100115,
"campaign_name": "Test name",
"adgroup_id": 1000228,
"adgroup_name": "Test name",
"creative_id": 10001117,
"creative_name": "Test name",
"ad_type": "video",
"country": "BR",
"clicks": 104.0,
"conversions": 0.0,
"cost": 0.08020019578,
"impressions": 214.0
}
]
}
}