1.3.2 获取报告数据
优质
小牛编辑
123浏览
2023-12-01
功能
根据站点ID获取站点报告数据
接口
- 百度商业账号
https://api.baidu.com/json/tongji/v1/ReportService/getData
- 百度账号
https://openapi.baidu.com/rest/2.0/tongji/report/getData
用户相关性
用户相关
应用级请求参数
基本参数
| 参数名 | 参数类型 | 是否必需 | 描述 |
|---|---|---|---|
| site_id | uint | 是 | 站点 |
| method | string | 是 | 通常对应要查询的报告 |
| start_date | string | 是 | 查询起始时间，例如：20190501 |
| end_date | string | 是 | 查询结束时间，例如：20190531 |
| start_date2 | string | 否 | 对比查询起始时间 |
| end_date2 | string | 否 | 对比查询结束时间 |
| metrics | string | 是 | 自定义指标选择，多个指标用逗号分隔 |
| order | string | 否 | 指标排序，示例：visitor_count,desc |
| start_index | uint | 否 | 获取数据偏移，用于分页；默认是 0 |
| max_results | uint | 否 | 单次获取数据条数，用于分页；默认是 20； 0 表示获取所有数据。 |
注：
method参数，通常对应要查询的报告，与网站页面所发送请求的method参数一致。例如要获取趋势分析报告的数据，所用到的方法为"trend/time/a"。
metrics参数，是所要获取的指标，根据不同的报告填写相关指标，与网站页面所发送请求的indicators参数一致。例如要获取浏览量(PV)、访客数(UV)、新访客数，则所填指标为"pv_count,visitor_count,new_visitor_count"。
详见下面"关键参数与报告的对应"的描述。
筛选参数
| 参数名 | 参数类型 | 是否必需 | 描述 |
|---|---|---|---|
| gran | string | 否 | 时间粒度(只支持有该参数的报告)： day/hour/week/month |
| target | int | 否 | 转化目标: -1 : 全部页面目标 -2 : 全部事件目标 -3 : 时长目标 -4 : 访问页数目标 |
| source | string | 否 | 来源过滤: through : 直接访问 search,0 : 搜索引擎全部 link : 外部链接 |
| clientDevice | string | 否 | 设备过滤 pc : 计算机 mobile : 移动设备 |
| area | string | 否 | 地域过滤 china: 全国 province,1: 北京 province,2: 上海 province,3: 天津 province,4: 广东 province,5: 福建 province,8: 海南 province,9: 安徽 province,10: 贵州 province,11: 甘肃 province,12: 广西 province,13: 河北 province,14: 河南 province,15: 黑龙江 province,16: 湖北 province,17: 湖南 province,18: 吉林 province,19: 江苏 province,20: 江西 province,21: 辽宁 province,22: 内蒙古 province,23: 宁夏 province,24: 青海 province,26: 山东 province,27: 山西 province,28: 陕西 province,29: 四川 province,30: 西藏 province,31: 新疆 province,32: 浙江 province,33: 重庆 province,34: 香港 province,35: 台湾 province,36: 澳门 |
| visitor | string | 否 | 访客过滤: new: 新访客 old : 老访客 |
关键参数与报告的对应
网站概况
网站概况(趋势数据)
网站概况(地域分布)
网站概况(来源网站、搜索词、入口页面、受访页面)
流量分析
趋势分析
实时访客
百度推广
推广方式
百度推广趋势
来源分析
全部来源
搜索引擎
搜索词
外部链接
访客分析
- 受访页面
- 入口页面
- 受访域名
- 地域分布(按省)
- 地域分布(按国家)
返回格式
| 参数名 | 参数类型 | 是否必须 | 描述 |
|---|---|---|---|
| result | ReportData | 是 | 报告数据 |
- ReportData结构
| 参数名 | 参数类型 | 是否必须 | 描述 |
|---|---|---|---|
| fields | array of string | 是 | 指标列表 |
| sum | array of string | 是 | 总计数据 |
| items | array | 是 | 指标数据，有 4 部分构成: 0 维度数据 1 指标数据 2 对比时间段数据 3 变化率数据 |
| total | uint | 是 | 总计条目 |
示例
这里通过列举若干调用实例来进一步阐述该接口的使用方法，其中会根据获取数据的不同而传入不同的请求参数。
示例一：获取趋势分析报告中 PV 和 UV 数据，按天粒度
| 参数 | 值 | 描述 |
|---|---|---|
| site_id | site_id | site_id |
| method | trend/time/a | 趋势分析报告 |
| start_date | 20190501 | 所查询数据的起始日期 |
| end_date | 20190531 | 所查询数据的结束日期 |
| metrics | pv_count,visitor_count | 所查询指标为 PV 和 UV |
| max_results | 0 | 返回所有条数 |
| gran | day | 按天粒度 |
- 百度商业账号
请求
{
"header": {
"username": "zhangsan",
"password": "xxxxxxxx",
"token": "xxxxxxxx",
"account_type": 1
},
"body": {
"site_id": "xxxx", //您的site_id
"start_date": "20190501",
"end_date": "20190531",
"metrics": "pv_count,visit_count",
"method": "trend/time/a",
"max_results": "0",
"gran": "day"
}
}
- 百度账号
请求
https://openapi.baidu.com/rest/2.0/tongji/report/getData?access_token=xxxxxxxx&site_id=xxxx&method=trend/time/a&start_date=20190501&end_date=20190531&metrics=pv_count,visit_count&max_results=0&gran=day
示例二：获取地域分布报告中的跳出率、平均访问时长、平均访问页数指标，按平均访问页数指标排序(倒序)，并做新访客的筛选
| 参数 | 值 | 描述 |
|---|---|---|
| site_id | 数字ID | 站点 ID |
| start_date | 20190501 | 所查询数据的起始日期 |
| end_date | 20190531 | 所查询数据的结束日期 |
| metrics | bounce_ratio,avg_visit_time,avg_visit_pages | 所查询指标为跳出率、平均访问时长、平均访问页数 |
| visitor | new | 新访客筛选 |
| order | avg_visit_pages,desc | 按平均访问页数指标排序(倒序) |
| method | visit/district/a | 地域分布报告 |
- 百度商业账号
请求
{
"header": {
"username": "zhangsan",
"password": "xxxxxxxx",
"token": "xxxxxxxx",
"account_type": 1
},
"body": {
"site_id": "xxxx", //您的site_id
"start_date": "20190501",
"end_date": "20190531",
"metrics": "bounce_ratio,avg_visit_time,avg_visit_pages",
"method": "visit/district/a",
"order": "avg_visit_pages,desc",
"visitor": "new"
}
}
- 百度账号
请求
https://openapi.baidu.com/rest/2.0/tongji/report/getData?access_token=xxxxxxxx&site_id=xxxx&method=visit/district/a&start_date=20190501&end_date=20190531&metrics=bounce_ratio,avg_visit_time,avg_visit_pages&order=avg_visit_pages,desc&visitor=new
响应示例
- 百度商业账号
{
"header": {
"desc": "success",
"failures": [
],
"oprs": 1,
"succ": 1,
"oprtime": 1,
"quota": 1,
"rquota": 1538,
"status": 0
},
"body": {
"data": [
{
"result": {
"offset": 0,
"timeSpan": [
"2019/05/31"
],
"fields": [
"visit_district_title",
"pv_count",
"visitor_count",
"ip_count"
],
"total": 35,
"sum": [
[
88498794,
35978529,
25665169
],
[
]
],
"pageSum": [
[
35405459,
14085496,
9982100
],
[
],
[
]
],
"items": [
[
[
{
"name": "广东",
"area": "province,4"
}
],
[
{
"name": "浙江",
"area": "province,32"
}
],
[
{
"name": "其他",
"area": "province,0"
}
],
[
{
"name": "江苏",
"area": "province,19"
}
],
[
{
"name": "河南",
"area": "province,14"
}
]
],
[
[
12341436,
4761366,
3272131
],
[
6246400,
2439809,
1818061
],
[
5843763,
2371240,
1583733
],
[
5187199,
2163779,
1523869
]
],
[
],
[
]
]
}
}
]
}
}
- 百度账号
{
"result": {
"offset": 0,
"timeSpan": [
"2019/05/31"
],
"fields": [
"visit_district_title",
"pv_count",
"visitor_count",
"ip_count"
],
"total": 35,
"sum": [
[
88498794,
35978529,
25665169
],
[
]
],
"pageSum": [
[
35405459,
14085496,
9982100
],
[
],
[
]
],
"items": [
[
[
{
"name": "广东",
"area": "province,4"
}
],
[
{
"name": "浙江",
"area": "province,32"
}
],
[
{
"name": "其他",
"area": "province,0"
}
],
[
{
"name": "江苏",
"area": "province,19"
}
],
[
{
"name": "河南",
"area": "province,14"
}
]
],
[
[
12341436,
4761366,
3272131
],
[
6246400,
2439809,
1818061
],
[
5843763,
2371240,
1583733
],
[
5187199,
2163779,
1523869
]
],
[
],
[
]
]
}
}