阅读(4252)
赞(1)
微信小程序 getVisitDistribution
2020-07-29 09:54:06 更新
analysis.getVisitDistribution
本接口应在服务器端调用,详细说明参见服务端API。
本接口支持云调用。需开发者工具版本 >= 1.02.1904090(最新稳定版下载)
wx-server-sdk >= 0.4.0
获取用户小程序访问分布数据
调用方式:
- HTTPS 调用
- 云调用
HTTPS 调用
请求地址
POST https://api.weixin.qq.com/datacube/getweanalysisappidvisitdistribution?access_token=ACCESS_TOKEN
请求参数
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
access_token | string | 是 | 接口调用凭证 | |
begin_date | string | 是 | 开始日期。格式为 yyyymmdd | |
end_date | string | 是 | 结束日期,限定查询 1 天数据,允许设置的最大值为昨日。格式为 yyyymmdd |
返回值
Object
返回的 JSON 数据包
属性 | 类型 | 说明 |
---|---|---|
ref_date | string | 日期,格式为 yyyymmdd |
list | Array.<Object> | 数据列表 |
list 的结构
属性 | 类型 | 说明 |
---|---|---|
index | number | 分布类型 |
item_list | Array.<Object> | 分布数据列表 |
index 的合法值
值 | 说明 | 最低版本 |
---|---|---|
access_source_session_cnt | 访问来源分布 | |
access_staytime_info | 访问时长分布 | |
access_depth_info | 访问深度的分布 |
item_list 的结构
属性 | 类型 | 说明 |
---|---|---|
key | number | 场景 id,定义在各个 index 下不同,具体参见下方表格 |
value | number | 该场景 id 访问 pv |
access_source_visit_uv | number | 该场景 id 访问 uv |
请求数据示例
{
"begin_date" : "20170313",
"end_date" : "20170313"
}
返回数据示例
{
"ref_date": "20170313",
"list": [
{
"index": "access_source_session_cnt",
"item_list": [
{
"key": 10,
"value": 5
},
{
"key": 8,
"value": 687
},
{
"key": 7,
"value": 10740
},
{
"key": 6,
"value": 1961
},
{
"key": 5,
"value": 677
},
{
"key": 4,
"value": 653
},
{
"key": 3,
"value": 1120
},
{
"key": 2,
"value": 10243
},
{
"key": 1,
"value": 116578
}
]
},
{
"index": "access_staytime_info",
"item_list": [
{
"key": 8,
"value": 16329
},
{
"key": 7,
"value": 19322
},
{
"key": 6,
"value": 21832
},
{
"key": 5,
"value": 19539
},
{
"key": 4,
"value": 29670
},
{
"key": 3,
"value": 19667
},
{
"key": 2,
"value": 11794
},
{
"key": 1,
"value": 4511
}
]
},
{
"index": "access_depth_info",
"item_list": [
{
"key": 5,
"value": 217
},
{
"key": 4,
"value": 3259
},
{
"key": 3,
"value": 32445
},
{
"key": 2,
"value": 63542
},
{
"key": 1,
"value": 43201
}
]
}
]
}
访问来源 key 对应关系(index="access_source_session_cnt"),场景值说明参见 场景值
key | 访问来源 | 对应场景值 |
---|---|---|
1 | 小程序历史列表 | 1001 1002 1004 |
2 | 搜索 | 1005 1006 1027 1042 1053 1106 1108 1132 |
3 | 会话 | 1007 1008 1044 1093 1094 1096 |
4 | 扫一扫二维码 | 1011 1025 1047 1105 1124 1150 |
5 | 公众号主页 | 1020 |
6 | 聊天顶部 | 1022 |
7 | 系统桌面 | 1023 1113 1114 1117 |
8 | 小程序主页 | 1024 1135 |
9 | 附近的小程序 | 1026 1033 1068 |
11 | 模板消息 | 1014 1043 1107 1162 |
12 | 客服消息 | 1021 |
13 | 公众号菜单 | 1035 1102 1130 |
14 | APP分享 | 1036 |
15 | 支付完成页 | 1034 1060 1072 1097 1109 1137 1149 |
16 | 长按识别二维码 | 1012 1048 1050 1125 |
17 | 相册选取二维码 | 1013 1049 1126 |
18 | 公众号文章 | 1058 1091 |
19 | 钱包 | 1019 1057 1061 1066 1070 1071 |
20 | 卡包 | 1028 1128 1148 |
21 | 小程序内卡券 | 1029 1062 |
22 | 其他小程序 | 1037 |
23 | 其他小程序返回 | 1038 |
24 | 卡券适用门店列表 | 1052 |
25 | 搜索框快捷入口 | 1054 |
26 | 小程序客服消息 | 1073 1081 |
27 | 公众号下发 | 1074 1076 1082 1152 |
28 | 系统会话菜单 | 1080 1083 1088 |
29 | 任务栏-最近使用 | 1089 |
30 | 长按小程序菜单圆点 | 1085 1090 1147 |
31 | 连wifi成功页 | 1064 1078 |
32 | 城市服务 | 1092 |
33 | 微信广告 | 1045 1046 1067 1084 1095 |
34 | 其他移动应用 | 1065 1069 1111 1140 |
35 | 发现入口-我的小程序 | 1003 1103 |
36 | 任务栏-我的小程序 | 1104 |
37 | 微信圈子 | 1138 1163 |
38 | 手机充值 | 1098 |
39 | H5 | 1018 1055 |
40 | 插件 | 1040 1041 1099 |
41 | 大家在用 | 1118 1145 |
42 | 发现页 | 1112 1141 1142 1143 |
43 | 浮窗 | 1131 |
44 | 附近的人 | 1075 1134 |
45 | 看一看 | 1115 |
46 | 朋友圈 | 1009 1110 1154 1155 |
47 | 企业微信 | 1119 1120 1121 1122 1123 1156 |
48 | 视频 | 1136 1144 |
49 | 收藏 | 1010 |
50 | 微信红包 | 1100 |
51 | 微信游戏中心 | 1079 1127 |
52 | 摇一摇 | 1039 1077 |
53 | 公众号导购消息 | 1157 |
54 | 识物 | 1153 |
55 | 小程序订单 | 1151 |
56 | 小程序直播 | 1161 |
57 | 群工具 | 1158 1159 1160 |
10 | 其他 | 除上述外其余场景值 |
访问时长 key 对应关系(index="access_staytime_info")
key | 访问时长 |
---|---|
1 | 0-2s |
2 | 3-5s |
3 | 6-10s |
4 | 11-20s |
5 | 20-30s |
6 | 30-50s |
7 | 50-100s |
8 | >100s |
平均访问深度 key 对应关系(index="access_depth_info")
key | 访问时长 |
---|---|
1 | 1 页 |
2 | 2 页 |
3 | 3 页 |
4 | 4 页 |
5 | 5 页 |
6 | 6-10 页 |
7 | >10 页 |
云调用
云调用是小程序·云开发提供的在云函数中调用微信开放接口的能力,需要在云函数中通过 wx-server-sdk 使用。
接口方法
openapi.analysis.getVisitDistribution
需在 config.json 中配置 analysis.getVisitDistribution API 的权限,详情
请求参数
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
beginDate | string | 是 | 开始日期。格式为 yyyymmdd | |
endDate | string | 是 | 结束日期,限定查询 1 天数据,允许设置的最大值为昨日。格式为 yyyymmdd |
返回值
Object
返回的 JSON 数据包
属性 | 类型 | 说明 |
---|---|---|
refDate | string | 日期,格式为 yyyymmdd |
list | Array.<Object> | 数据列表 |
list 的结构
属性 | 类型 | 说明 |
---|---|---|
index | number | 分布类型 |
itemList | Array.<Object> | 分布数据列表 |
index 的合法值
值 | 说明 | 最低版本 |
---|---|---|
access_source_session_cnt | 访问来源分布 | |
access_staytime_info | 访问时长分布 | |
access_depth_info | 访问深度的分布 |
itemList 的结构
属性 | 类型 | 说明 |
---|---|---|
key | number | 场景 id,定义在各个 index 下不同,具体参见下方表格 |
value | number | 该场景 id 访问 pv |
accessSourceVisitUv | number | 该场景 id 访问 uv |
请求数据示例
const cloud = require('wx-server-sdk')
cloud.init()
exports.main = async (event, context) => {
try {
const result = await cloud.openapi.analysis.getVisitDistribution({
beginDate: '20170313',
endDate: '20170313'
})
return result
} catch (err) {
return err
}
}
返回数据示例
{
"refDate": "20170313",
"list": [
{
"index": "access_source_session_cnt",
"itemList": [
{
"key": 10,
"value": 5
},
{
"key": 8,
"value": 687
},
{
"key": 7,
"value": 10740
},
{
"key": 6,
"value": 1961
},
{
"key": 5,
"value": 677
},
{
"key": 4,
"value": 653
},
{
"key": 3,
"value": 1120
},
{
"key": 2,
"value": 10243
},
{
"key": 1,
"value": 116578
}
]
},
{
"index": "access_staytime_info",
"itemList": [
{
"key": 8,
"value": 16329
},
{
"key": 7,
"value": 19322
},
{
"key": 6,
"value": 21832
},
{
"key": 5,
"value": 19539
},
{
"key": 4,
"value": 29670
},
{
"key": 3,
"value": 19667
},
{
"key": 2,
"value": 11794
},
{
"key": 1,
"value": 4511
}
]
},
{
"index": "access_depth_info",
"itemList": [
{
"key": 5,
"value": 217
},
{
"key": 4,
"value": 3259
},
{
"key": 3,
"value": 32445
},
{
"key": 2,
"value": 63542
},
{
"key": 1,
"value": 43201
}
]
}
],
"errMsg": "openapi.analysis.getVisitDistribution:ok"
}