Help centerAdvanced Performance Reporting
You need to use Token, for more details, please check token
Description of the time for pulling report data: The data will be available about 5 hours after the day. It is recommended to pull it after 5 am the next day.
Example: Suppose you pull the data of August 1st in UTC+0, and the data can be retrieved after 5:00 am on August 2 in UTC+0.
Request Address
https://scaler.taurusx.com/openapi/performance_data
Request Method
GET
Request Parameters
| Field | Required | Type | Description | Default | Example |
|---|---|---|---|---|---|
| timezone | Optional | string | Timezone | +0 | +0 |
| report_type | Optional | string | Type of report statistics, event|request | event | event |
| start_time | Required | string | The start time of the requested data, in the format of "yyyy-MM-dd". Supports querying for the past week. | —— | "2023-04-23" |
| end_time | Required | string | The end time of the requested data, in the format of "yyyy-MM-dd". Supports querying for the past week. | —— | "2023-04-24" |
| dimension_option | Required | string | Enum field names: "Campaign", "Adgroup", "Creative", "AdType", "Country". Separate with commas for multiple fields. dimension_option=> "Campaign", Segment data by Campaign ID; dimension_option=> "Adgroup", Segment data by Adgroup ID; dimension_option=> "Creative", Segment data by Creative ID; dimension_option=> "AdType", Segment data by Ad Type;dimension_option=> "Country", Segment data by country (two-letter country code). | —— | Campaign,Country |
Response Results
| Name | Parent Node | Type | Description |
|---|---|---|---|
| code | int | 200 means success, others mean failure | |
| data | json | Result list | |
| data_list | data | array<json> | |
| date | data_list | string | Date |
| campaign_id | data_list | string | Campaign ID |
| campaign_name | data_list | string | Campaign Name |
| adgroup_id | data_list | string | Adgroup ID |
| adgroup_name | data_list | string | Adgroup Name |
| creative_id | data_list | string | Creative ID |
| creative_name | data_list | string | Creative Name |
| ad_type | data_list | string | Creative type:image,nativeImg,video,videoEndCard,html,videoHtml |
| country | data_list | string | Country Code |
| impressions | data_list | number | Impressions |
| clicks | data_list | number | Clicks |
| conversions | data_list | number | Conversions |
| cost | data_list | number | Cost , in US dollars |
- Response example
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
},
]
}
}