百度统计Tongji API可以为网站接入者提供便捷的获取网站流量数据的通道, 从而使网站接入者可向网站帐号提供数据分析、运营监控、网站推广等服务。该用户手册分为三册,全集包含 1.接口概述、2. 接口列表、3.常见问题
本期主要讲解第二部分:接口列表


现阶段 Tongji API 提供给您的接口有:

获取站点列表

一、功能

获取用户的站点和子目录列表,不包括权限站点和汇总网站。

二、接口

  • 百度商业账号

https://api.baidu.com/json/tongji/v1/ReportService/getSiteList
  • 百度账号

https://openapi.baidu.com/rest/2.0/tongji/config/getSiteList

三、用户相关性

用户相关

四、应有级请求参数

五、返回格式

参数名参数类型是否必须描述
listarray of SiteInfo站点列表
  • SiteInfo 结构

参数名参数类型是否必须描述
site_iduint应用 ID
domainstring站点域名
statusuint0 : 正常 ; 1: 暂停
create_timeDateTime日期时间格式,以北京时间表示
sub_dir_listarray of SubDirInfo子目录列表
  • SubDirInfo 结构

参数名参数类型是否必须描述
sub_dir_iduint子目录 ID
namestring子目录名称
statusuint0: 正常 ; 1 : 暂停
create_timeDateTime日期时间格式, 以北京时间表示
sub_dir_listarray of SubDirInfo子目录列表

六、示例

  • 百度商业账号

请求

{    "header": {        "username": "zhangsan", //您的用户名
        "password": "xxxxxxxx", //您的密码
        "token": "xxxxxxxx",    //您的token
        "account_type": 1
    }
}

响应

{    "header": {        "desc": "success",        "failures": [], 
        "oprs": 1,        "succ": 1, 
        "oprtime": 1, 
        "quota": 1, 
        "rquota": 1538, 
        "status": 0
    }, 
    "body": {        "data": [
            {                "list": [ 
                    {                        "site_id": 12345,                        "domain": "www.iqiyi.com",                        "status": 0,                        "create_time": "2019-01-01 15:00:00",                        "sub_dir_list": [
                                {                                 "sub_dir_id": 53679,                                 "name": "视频",                                 "create_time": "2019-01-02 15:00:00"
                                }, 
                                {                                "sub_dir_id": 23748,                                "name": "我的积分",                                "create_time": "2019-01-03 15:00:00"
                                }
                          ]
                     },
                    {                        "site_id": 34934,                        "domain": "www.iqiyi.com/life", 
                        "status": 0,                        "create_time": "2019-01-04 15:00:00", 
                        "sub_dir_list": []
                    } 
                ]
            },
        ]
    }
}
  • 百度账号

请求

https://openapi.baidu.com/rest/2.0/tongji/config/getSiteList?access_token=xxxxxxxx

响应

{    "list": [ 
        {            "site_id": 12345,            "domain": "www.iqiyi.com",            "status": 0,            "create_time": "2019-01-01 15:00:00",            "sub_dir_list": [
                    {                     "sub_dir_id": 53679,                     "name": "视频",                     "create_time": "2019-01-02 15:00:00"
                    }, 
                    {                    "sub_dir_id": 23748,                    "name": "我的积分",                    "create_time": "2019-01-03 15:00:00"
                    }
              ]
         },
        {            "site_id": 34934,            "domain": "www.iqiyi.com/life", 
            "status": 0,            "create_time": "2019-01-04 15:00:00", 
            "sub_dir_list": []
        } 
    ]
}



获取报告数据

一、功能

根据站点ID获取站点报告数据

二、接口

  • 百度商业账号

https://api.baidu.com/json/tongji/v1/ReportService/getData
  • 百度账号

https://openapi.baidu.com/rest/2.0/tongji/report/getData

三、用户相关性

用户相关

四、应用级请求参数


基本参数
参数名参数类型是否必需描述
site_iduint站点
methodstring通常对应要查询的报告
start_datestring查询起始时间,例如:20190501
end_datestring查询结束时间,例如:20190531
start_date2string对比查询起始时间
end_date2string对比查询结束时间
metricsstring自定义指标选择,多个指标用逗号分隔
orderstring指标排序,示例:visitor_count,desc
start_indexuint获取数据偏移,用于分页;默认是 0
max_resultsuint单次获取数据条数,用于分页;默认是 20;
0 表示获取所有数据。

注:

  • method参数,通常对应要查询的报告,与网站页面所发送请求的method参数一致。例如要获取趋势分析报告的数据,所用到的方法为"trend/time/a"。

  • metrics参数,是所要获取的指标,根据不同的报告填写相关指标,与网站页面所发送请求的indicators参数一致。例如要获取浏览量(PV)、访客数(UV)、新访客数,则所填指标为"pv_count,visitor_count,new_visitor_count"。

详见下面"关键参数与报告的对应"的描述。

筛选参数
参数名参数类型是否必需描述
granstring时间粒度(只支持有该参数的报告):
day/hour/week/month
targetint转化目标:
-1 : 全部页面目标
-2 : 全部事件目标
-3 : 时长目标
-4 : 访问页数目标
sourcestring来源过滤:
through : 直接访问
search,0 : 搜索引擎全部
link : 外部链接
clientDevicestring设备过滤
pc : 计算机
mobile : 移动设备
areastring地域过滤
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: 澳门
visitorstring访客过滤:
new: 新访客
old : 老访客



更多关键参数与报告的对应情况,请访问统计官网:https://tongji.baidu.com/api/manual/Chapter1/getData.html