如何获取站点的报告数据

优质
小牛编辑
132浏览
2023-12-01
使用指南 - 数据报告 - Tongji API - 如何获取站点的报告数据

功能

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

接口名称

https://api.baidu.com/json/tongji/v1/ReportService/getData

用户相关性

用户相关

应用级输入参数

基本参数


参数名参数类型是否必需描述
site_iduint站点id
method通常对应要查询的报告
start_date查询起始时间,例:20160501
end_date查询结束时间,例:20160531
start_date2对比查询起始时间
end_date2对比查询结束时间
metrics自定义指标选择,多个指标用逗号分隔
gran时间粒度(只支持有该参数的报告): day/hour/week/month
order指标排序,示例:visitor_count,desc
start_indexuint获取数据偏移,用于分页;默认是0
max_resultsuint单次获取数据条数,用于分页;默认是20;
0表示获取所有数据.

注:

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

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

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

筛选参数


参数名参数类型是否必需描述
targetint转化目标:1:全部页面目标 2:全部事件目标 3:时长目标 4:访问页数目标
sourcestring来源过滤: through:直接访问 search,0:搜索引擎全部 link:外部链接
clientDevicestring设备过滤 pc:计算机 mobile:移动设备
areastring地域过滤 china:全国 province,1:省市自治区北京 province,2:省市自治区上海 province,3:省市自治区天津 … other:其他
visitorstring访客过滤 new:新访客 old:老访客

关键参数与报告的对应



()


()

请求示例

这里通过列举若干调用实例来进一步阐述该接口的使用方式,其中会根据获取数据的不同而传入不同的请求参数。

1.获取趋势分析报告中PV和UV数据,按天粒度

2.获取地域分布报告中的跳出率、平均访问时长、平均访问页数指标,按平均

访问页数指标排序(倒序),并做新访客的筛选。

返回参数


参数名参数类型是否必需描述
resultReportData报告数据

ReportData结构



返回示例

{ 
    "header": { 
        "desc": "success", 
        "failures": [], 
        "oprs": 1, 
        "succ": 1, 
        "oprtime": 1, 
        "quota": 1, 
        "rquota": 1538, 
        "status": 0 
    }, 
    "body": { 
        "data": [ 
            { 
                "result": { 
                    "offset": 0, 
                    "timeSpan": [ 
                        "2016/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 
                            ], 
                            [ 
                                5786661, 
                                2349302, 
                                1784306 
                            ], 
                            [ 
                                5187199, 
                                2163779, 
                                1523869 
                            ] 
                        ], 
                        [], 
                        [] 
                    ] 
                } 
            } 
        ] 
    } 
}