1.3.4 基木鱼数据导出服务
优质
小牛编辑
141浏览
2023-12-01
功能
获取基木鱼站点数据,主要包括“自定义页面分析”上的数据。
接口
- 仅支持百度商业账号
https://api.baidu.com/json/tongji/v1/ReportService/getJimuyuData
用户相关性
用户相关
应用级请求参数
参数名 | 参数类型 | 是否必需 | 描述 |
---|---|---|---|
start_date | string | 是 | 查询起始时间,示例:"20200401" |
end_date | string | 是 | 查询结束时间,示例:"20200407" |
metrics | string[] | 是 | 指标,示例:["页面浏览PV","页面浏览UV"] |
dimensions | string[] | 否 | 维度,示例:["百度推广渠道_","受访域名_"] |
where | object | 否 | 筛选条件,示例: {"op":"AND","items":[{"key":"province_","op":"=","val":["上海"]}]} |
order | string | 否 | 维度指标排序,示例:"metric_0,desc" |
max_results | int | 否 | 获取数据条数,默认20条,最大限制5000条 |
gran | string | 否 | 时间粒度,默认全部,示例:"day" 支持的枚举值包括:default/hour/day/week/month/year |
metrics参数
对于预置指标,通过string[]类型指定,所有的枚举项如下:
页面浏览PV
页面浏览UV
页面有效浏览平均时长
页面有效浏览人均时长
页面浏览时长最大值
页面浏览时长最小值
页面退出率
会话次数
会话人数
会话跳出率
会话平均有效访问时长
会话人均有效访问时长
会话平均访问页数
会话人均访问页数
咨询按钮点击次数
咨询按钮点击人数
电话按钮点击次数
电话按钮点击人数
表单调起按钮点击次数
表单调起按钮点击人数
表单提交按钮点击次数
表单提交按钮点击人数
下载按钮点击次数
下载按钮点击人数
评价调起按钮点击次数
评价调起按钮点击人数
微信复制按钮点击次数
微信复制按钮点击人数
回呼按钮点击次数
回呼按钮点击人数
开始抽奖按钮点击次数
开始抽奖按钮点击人数
卡券领取按钮点击次数
卡券领取按钮点击人数
订单提交按钮点击次数
订单提交按钮点击人数
订单提交成功次数
订单提交成功人数
订单支付成功次数
订单支付成功人数
进入直播间次数
进入直播间人数
微信调起次数
微信调起人数
表单提交成功次数
表单提交成功人数
卡券领取次数
卡券领取人数
抽奖留线次数
抽奖留线人数
有效咨询次数
有效咨询人数
高质量咨询次数
高质量咨询人数
客服在线次数
客服在线人数
咨询留联次数
咨询留联人数
视频播放量
视频有效播放平均时长
播放率
播放完成次数
播放完成率
播放进度大于75%次数
播放进度大于50%次数
播放进度大于25%次数
dimensions参数
通过string[]类型指定,所有的枚举项如下:
受访域名_
页面地址_
页面停留时长_
是否是入口页_
是否是退出页_
贡献下游流量_
页面标题_
页面路径_
页面ID_
站点ID_
站点名称_
站点首页地址_
模板类型_
IP_
百度推广渠道_
搜索推广计划_
搜索推广单元_
搜索推广关键词_
搜索推广搜索词_
信息流推广计划_
信息流推广单元_
推广落地页_
省份_
城市_
国家_
运营商_
访问设备_
浏览器类型_
操作系统_
屏幕尺寸_
元素Xpath_
元素ID_
元素内容_
元素类型_
元素链接地址_
访问时长_
是否单PV会话_
访问页数_
事件名称_
播放时长_
播放次数_
站点类型_
视频播放进度_
信息流推广范围_
门店中心商品ID
门店中心页面类型
门店ID
商盾ID_
动态落地页编辑版本号_
动态落地页版本号_
注意:名称后面的下划线不可省略。
where参数
通过object类型指定,整体结构如下:
{
"op": "AND",
"items": [{
"key": "province_",
"op": "=",
"val": ["上海", "北京"]
}, {
"key": "browser_",
"op": "LIKE",
"val": ["Chrome"]
}, {
"key": "page_duration_",
"op": ">",
"val": [30]
}, {
"key": "is_last_page_",
"op": "YES",
"val": []
}]
}
- 最外的op支持AND和OR两种形式
- items中的key如下表描述,其中不同的key根据属性类型支持不同的op:
key(属性标识) | 属性名称 | 属性类型 |
---|---|---|
visitdomain_ | 受访域名_ | 字符串型 |
page_name_ | 页面地址_ | 字符串型 |
page_duration_ | 页面停留时长_ | 数值型 |
is_first_page_ | 是否是入口页_ | 布尔型 |
is_last_page_ | 是否是退出页_ | 布尔型 |
page_outward_count_ | 贡献下游流量_ | 数值型 |
title_ | 页面标题_ | 字符串型 |
url_path_ | 页面路径_ | 字符串型 |
jmy_page_id_ | 页面ID_ | 字符串型 |
jmy_site_id_ | 站点ID_ | 字符串型 |
jmy_sitename_ | 站点名称_ | 字符串型 |
jmy_siteindexurl_ | 站点首页地址_ | 字符串型 |
jmy_tpl_type_ | 模板类型_ | 字符串型 |
ip_ | IP_ | 字符串型 |
adtype_ | 百度推广渠道_ | 字符串型 |
adplan_ | 搜索推广计划_ | 字符串型 |
fcunit_ | 搜索推广单元_ | 字符串型 |
adword_ | 搜索推广关键词_ | 字符串型 |
fcsearchword_ | 搜索推广搜索词_ | 字符串型 |
feedplan_ | 信息流推广计划_ | 字符串型 |
feedunit_ | 信息流推广单元_ | 字符串型 |
adurl_ | 推广落地页_ | 字符串型 |
province_ | 省份_ | 字符串型 |
city_ | 城市_ | 字符串型 |
country_ | 国家_ | 字符串型 |
isp_ | 运营商_ | 字符串型 |
device_type_ | 访问设备_ | 字符串型 |
browser_ | 浏览器类型_ | 字符串型 |
os_ | 操作系统_ | 字符串型 |
screen_resolution_ | 屏幕尺寸_ | 字符串型 |
at_element_xpath_ | 元素Xpath_ | 字符串型 |
at_element_id_ | 元素ID_ | 字符串型 |
at_element_content_ | 元素内容_ | 字符串型 |
at_element_tag_ | 元素类型_ | 字符串型 |
at_element_link_ | 元素链接地址_ | 字符串型 |
session_duration_ | 访问时长_ | 数值型 |
is_single_pv_session_ | 是否单PV会话_ | 布尔型 |
session_pv_count_ | 访问页数_ | 数值型 |
entity_note_name_ | 事件名称_ | 字符串型 |
video_play_duration_ | 播放时长_ | 数值型 |
video_play_count_ | 播放次数_ | 数值型 |
jmy_site_type_ | 站点类型_ | 字符串型 |
video_play_percent_ | 视频播放进度_ | 数值型 |
feed_sub_adtype_ | 信息流推广范围_ | 字符串型 |
md_id_ | 门店中心商品ID | 字符串型 |
md_type_ | 门店中心页面类型 | 字符串型 |
md_store_id_ | 门店ID | 字符串型 |
sdclickid_ | 商盾ID_ | 字符串型 |
jmy_edit_version_ | 动态落地页编辑版本号_ | 字符串型 |
jmy_dyn_id_ | 动态落地页版本号_ | 字符串型 |
注意:key后面的下划线不可省略。
- 字符串型key支持的op
op | 含义 | val数量 |
---|---|---|
= | 是 | 多项 |
!= | 不是 | 多项 |
LIKE | 包含 | 单项 |
NOTLIKE | 不包含 | 单项 |
WILDCARD | 通配 | 单项 |
- 数值型key支持的op
op | 含义 | val数量 |
---|---|---|
> | 大于 | 单项 |
< | 小于 | 单项 |
= | 等于 | 单项 |
>= | 大于等于 | 单项 |
<= | 小于等于 | 单项 |
!= | 不等于 | 单项 |
- 布尔型key支持的op,此类型不需要指定val
op | 含义 |
---|---|
YES | 是 |
NO | 否 |
order参数
通过string类型指定,示例如下:
- 时间维度顺序
dimension_time,asc
- 第1个维度倒序,注意是从0开始编号
dimension_0,desc
- 第2个指标顺序,注意是从0开始编号
metric_1,asc
返回格式
响应中的数据部分整体结构如下:
{
"detailData": {
"dimensionFields": ["date_", "visitdomain_"],
"metricFields": [{
"label": "页面浏览PV(A)",
"unit": ""
}, {
"label": "页面浏览UV(B)",
"unit": ""
}],
"dimensionRows": [
["2020\/04\/01", "aisite.wejianzhan.com"],
["2020\/04\/02", "aisite.wejianzhan.com"]
],
"metricRows": [
[100, 200],
[120, 230]
],
}
}
注意:实际返回的字段可能多于上述描述的字段。例如除了"detailData"信息之外,还有"totalData"信息,表示去除时间粒度之后的数据。实际处理时可以忽略多余的字段。
dimensionFields
表格列头维度列,如果指定gran参数则包括时间列
metricFields
表格列头指标列
dimensionRows
表格数据行维度部分
metricRows
表格数据行指标部分
示例
请求
{
"header": {
"username": "zhangsan",
"password": "xxxxxxxx",
"token": "xxxxxxxx",
"account_type": 1
},
"body": {
"start_date": "20200401",
"end_date": "20200402",
"metrics": ["页面浏览PV", "页面浏览UV"],
"dimensions": ["百度推广渠道_", "受访域名_"],
"order": "metric_0,desc",
"max_results": 20,
"gran": "day"
}
}
响应
{
"header": {
"desc": "success",
"failures": [
],
"oprs": 1,
"succ": 1,
"oprtime": 1,
"quota": 1,
"rquota": 1538,
"status": 0
},
"body": {
"data": [{
"result": {
"detailData": {
"dimensionFields": ["date_", "visitdomain_"],
"metricFields": [{
"label": "页面浏览PV(A)",
"unit": ""
}, {
"label": "页面浏览UV(B)",
"unit": ""
}],
"dimensionRows": [
["2020\/04\/01", "aisite.wejianzhan.com"],
["2020\/04\/02", "aisite.wejianzhan.com"]
],
"metricRows": [
[100, 200],
[120, 230]
],
"truncateCount": 2500,
"xAxis": ["2020\/04\/01", "2020\/04\/02"]
},
"totalData": {
"dimensionFields": ["visitdomain_"],
"metricFields": [{
"label": "页面浏览PV(A)",
"unit": ""
}, {
"label": "页面浏览UV(B)",
"unit": ""
}],
"dimensionRows": [
["aisite.wejianzhan.com"]
],
"metricRows": [
[220, 300]
]
}
}
}]
}
}