帮助中心投放效果报表接口
注意
调用接口需携带身份验证参数 Token，详见 Token 使用说明
说明：数据通常在当天结束后约 5 小时生成。例如，若查询零时区 8 月 1 日的数据，可在零时区 8 月 2 日凌晨 5 点左右获取。
请求地址
https://scaler.taurusx.com/openapi/performance_data
请求方法
GET
请求参数
| 字段 | 是否必填 | 类型 | 说明 | 默认值 | 示例 |
|---|---|---|---|---|---|
| timezone | 否 | string | 数据对应的时区 | +0 | +0 |
| report_type | 否 | string | 报表统计类型 | event | event |
| start_time | 是 | string | 请求数据的开始时间，格式 "yyyy-MM-dd"，支持最近一周查询 | — | "2023-04-23" |
| end_time | 是 | string | 请求数据的结束时间，格式 "yyyy-MM-dd"，支持最近一周查询 | — | "2023-04-24" |
| dimension_option | 是 | string | 统计维度，详见下方说明 | — | Campaign,Country |
dimension_option 说明
支持多个字段用英文逗号
,分隔。
"Campaign"：按 Campaign ID 细分数据"Adgroup"：按 Adgroup ID 细分数据"Creative"：按 Creative ID 细分数据"AdType"：按素材类型细分数据"Country"：按国家（两位国家码）细分数据
响应字段说明
| 名称 | 父节点 | 类型 | 描述 |
|---|---|---|---|
| code | — | int | 200 表示成功，其他表示失败 |
| data | — | json | 结果列表 |
| data_list | data | array<json> | 报表数据列表 |
| date | data_list | string | 日期，格式如 "yyyy-MM-dd" |
| campaign_id | data_list | string | Campaign ID |
| campaign_name | data_list | string | Campaign 名称 |
| adgroup_id | data_list | string | Adgroup ID |
| adgroup_name | data_list | string | Adgroup 名称 |
| creative_id | data_list | string | Creative ID |
| creative_name | data_list | string | Creative 名称 |
| ad_type | data_list | string | 素材类型，如 image、nativeImg、video、videoEndCard、html、videoHtml |
| country | data_list | string | 国家，两位国家码 |
| impressions | data_list | number | 展示次数 |
| clicks | data_list | number | 点击次数 |
| conversions | data_list | number | 转化次数 |
| cost | data_list | number | 消耗，单位美元 |
响应示例
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
}
]
}
}