analysis.getVisitDistribution

本接口应在服务器端调用，详细说明参见服务端API。

本接口支持云调用。需开发者工具版本 >= 1.02.1904090（最新稳定版下载），wx-server-sdk >= 0.4.0

获取用户小程序访问分布数据

调用方式：

HTTPS 调用

请求地址

  1. POST https://api.weixin.qq.com/datacube/getweanalysisappidvisitdistribution?access_token=ACCESS_TOKEN

请求参数

属性类型默认值必填说明
access_tokenstring是接口调用凭证
begin_datestring是开始日期。格式为 yyyymmdd
end_datestring是结束日期，限定查询 1 天数据，允许设置的最大值为昨日。格式为 yyyymmdd

返回值

Object

返回的 JSON 数据包

属性类型说明
ref_datestring日期，格式为 yyyymmdd
listArray.<Object>数据列表

list 的结构

属性类型说明
indexnumber分布类型
item_listArray.<Object>分布数据列表

index 的合法值

值说明最低版本
access_source_session_cnt访问来源分布
access_staytime_info访问时长分布
access_depth_info访问深度的分布

item_list 的结构

属性类型说明
keynumber场景 id，定义在各个 index 下不同，具体参见下方表格
valuenumber该场景 id 访问 pv
access_source_visit_uvnumber该场景 id 访问 uv

请求数据示例

  1. {
  2.   "begin_date" : "20170313",
  3.   "end_date" : "20170313"
  4. }

返回数据示例

  1. {
  2.   "ref_date": "20170313",
  3.   "list": [
  4.     {
  5.       "index": "access_source_session_cnt",
  6.       "item_list": [
  7.         {
  8.           "key": 10,
  9.           "value": 5
  10.         },
  11.         {
  12.           "key": 8,
  13.           "value": 687
  14.         },
  15.         {
  16.           "key": 7,
  17.           "value": 10740
  18.         },
  19.         {
  20.           "key": 6,
  21.           "value": 1961
  22.         },
  23.         {
  24.           "key": 5,
  25.           "value": 677
  26.         },
  27.         {
  28.           "key": 4,
  29.           "value": 653
  30.         },
  31.         {
  32.           "key": 3,
  33.           "value": 1120
  34.         },
  35.         {
  36.           "key": 2,
  37.           "value": 10243
  38.         },
  39.         {
  40.           "key": 1,
  41.           "value": 116578
  42.         }
  43.       ]
  44.     },
  45.     {
  46.       "index": "access_staytime_info",
  47.       "item_list": [
  48.         {
  49.           "key": 8,
  50.           "value": 16329
  51.         },
  52.         {
  53.           "key": 7,
  54.           "value": 19322
  55.         },
  56.         {
  57.           "key": 6,
  58.           "value": 21832
  59.         },
  60.         {
  61.           "key": 5,
  62.           "value": 19539
  63.         },
  64.         {
  65.           "key": 4,
  66.           "value": 29670
  67.         },
  68.         {
  69.           "key": 3,
  70.           "value": 19667
  71.         },
  72.         {
  73.           "key": 2,
  74.           "value": 11794
  75.         },
  76.         {
  77.           "key": 1,
  78.           "value": 4511
  79.         }
  80.       ]
  81.     },
  82.     {
  83.       "index": "access_depth_info",
  84.       "item_list": [
  85.         {
  86.           "key": 5,
  87.           "value": 217
  88.         },
  89.         {
  90.           "key": 4,
  91.           "value": 3259
  92.         },
  93.         {
  94.           "key": 3,
  95.           "value": 32445
  96.         },
  97.         {
  98.           "key": 2,
  99.           "value": 63542
  100.         },
  101.         {
  102.           "key": 1,
  103.           "value": 43201
  104.         }
  105.       ]
  106.     }
  107.   ]
  108. }

访问来源 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
14APP分享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
39H51018 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访问时长
10-2s
23-5s
36-10s
411-20s
520-30s
630-50s
750-100s
8>100s

平均访问深度 key 对应关系（index=”access_depth_info”）

key访问时长
11 页
22 页
33 页
44 页
55 页
66-10 页
7>10 页

云调用

云调用是小程序·云开发提供的在云函数中调用微信开放接口的能力，需要在云函数中通过 wx-server-sdk 使用。

接口方法

  1. openapi.analysis.getVisitDistribution

需在 config.json 中配置 analysis.getVisitDistribution API 的权限，详情

请求参数

属性类型默认值必填说明
beginDatestring是开始日期。格式为 yyyymmdd
endDatestring是结束日期，限定查询 1 天数据，允许设置的最大值为昨日。格式为 yyyymmdd

返回值

Object

返回的 JSON 数据包

属性类型说明
refDatestring日期，格式为 yyyymmdd
listArray.<Object>数据列表

list 的结构

属性类型说明
indexnumber分布类型
itemListArray.<Object>分布数据列表

index 的合法值

值说明最低版本
access_source_session_cnt访问来源分布
access_staytime_info访问时长分布
access_depth_info访问深度的分布

itemList 的结构

属性类型说明
keynumber场景 id，定义在各个 index 下不同，具体参见下方表格
valuenumber该场景 id 访问 pv
accessSourceVisitUvnumber该场景 id 访问 uv

请求数据示例

  1. const cloud = require('wx-server-sdk')
  2. cloud.init({
  3.   env: cloud.DYNAMIC_CURRENT_ENV,
  4. })
  5. exports.main = async (event, context) => {
  6.   try {
  7.     const result = await cloud.openapi.analysis.getVisitDistribution({
  8.         beginDate: '20170313',
  9.         endDate: '20170313'
  10.       })
  11.     return result
  12.   } catch (err) {
  13.     return err
  14.   }
  15. }

返回数据示例

  1. {
  2.   "refDate": "20170313",
  3.   "list": [
  4.     {
  5.       "index": "access_source_session_cnt",
  6.       "itemList": [
  7.         {
  8.           "key": 10,
  9.           "value": 5
  10.         },
  11.         {
  12.           "key": 8,
  13.           "value": 687
  14.         },
  15.         {
  16.           "key": 7,
  17.           "value": 10740
  18.         },
  19.         {
  20.           "key": 6,
  21.           "value": 1961
  22.         },
  23.         {
  24.           "key": 5,
  25.           "value": 677
  26.         },
  27.         {
  28.           "key": 4,
  29.           "value": 653
  30.         },
  31.         {
  32.           "key": 3,
  33.           "value": 1120
  34.         },
  35.         {
  36.           "key": 2,
  37.           "value": 10243
  38.         },
  39.         {
  40.           "key": 1,
  41.           "value": 116578
  42.         }
  43.       ]
  44.     },
  45.     {
  46.       "index": "access_staytime_info",
  47.       "itemList": [
  48.         {
  49.           "key": 8,
  50.           "value": 16329
  51.         },
  52.         {
  53.           "key": 7,
  54.           "value": 19322
  55.         },
  56.         {
  57.           "key": 6,
  58.           "value": 21832
  59.         },
  60.         {
  61.           "key": 5,
  62.           "value": 19539
  63.         },
  64.         {
  65.           "key": 4,
  66.           "value": 29670
  67.         },
  68.         {
  69.           "key": 3,
  70.           "value": 19667
  71.         },
  72.         {
  73.           "key": 2,
  74.           "value": 11794
  75.         },
  76.         {
  77.           "key": 1,
  78.           "value": 4511
  79.         }
  80.       ]
  81.     },
  82.     {
  83.       "index": "access_depth_info",
  84.       "itemList": [
  85.         {
  86.           "key": 5,
  87.           "value": 217
  88.         },
  89.         {
  90.           "key": 4,
  91.           "value": 3259
  92.         },
  93.         {
  94.           "key": 3,
  95.           "value": 32445
  96.         },
  97.         {
  98.           "key": 2,
  99.           "value": 63542
  100.         },
  101.         {
  102.           "key": 1,
  103.           "value": 43201
  104.         }
  105.       ]
  106.     }
  107.   ],
  108.   "errMsg": "openapi.analysis.getVisitDistribution:ok"
  109. }