报表 API

优质

小牛编辑

115浏览

2023-12-01

8.6.1 报表API说明

API可助您自动完成复杂的报告任务，从而节省您的时间。API返回的报告数据源于跟踪代码收集到的数据的统计。您可以使用API查询维度和指标，以创建自定义报告。

8.6.2 接口说明

接口格式：

Http GET ${HOST}/query/stat
/*
${HOST}为web后台地址
*/

注意：读取当天的数据目前限制为500行以内，历史数据建议为50000行以内。抽取速度没有明确限制。

GET的参数：

ViewId:1 //视图ID
SiteId:1 //站点ID

token : abc //授权token
begindate:1434988800 //开始时间,精确到秒, 注意：今天的和历史的数据不能混合查询,否则只查询历史的
enddate:1435075199 //结束时间,精确到秒, 注意：今天的和历史的数据不能混合查询,否则只查询历史的
sort:pageviews|-1 //排序指标, -1表示逆序,1表示正序
page:1 //页数
limit:20 //条数
debug:true //是否开启debug
metrics:pageviews,page_sessions,avg_stay_time //指标,逗号分割
dims:page_domain_id //纬度,逗号分割
condition: jsonStr //过滤 兼容bson风格,目前支持的操作符有：
比较: $gt $gte $in $lt $lte $ne $nin $e
逻辑合并: $or $and $not $nor
比如
{
"country_name": 88,
"$or":[
{"country_id":{"$in": [1001, 1002], "$gt": 20}},
{"impressions":{"$in": [33,44]}}
]
}
当前token只开通 精确过滤权限, 简单k,v结构即可,如 condition={"page_path_id" : "/", "page_domain_id" :"XXXX"}

8.6.3 示例说明

请求URL：

/query/stat?begindate=1434988800&enddate=1435075199&sort=pageviews%7C-1&page=1&limit=20&debug=true&metrics=pageviews%2Cpage_sessi"ons%2Cavg_stay_time&dims=page_domain_id&ViewId=1&SiteId=1&token=abcdef

Tips:可通过系统快速获得上述请求URL

在预定报表或自定义报表处，配置好所需要的报表及时间。打开chrome开发者工具，点击“刷新”，获取请求URL（这种方法获取的URL并没有token字段，使用时记得要加上）