analysis.getMonthlyRetain

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

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

获取用户访问小程序月留存

调用方式:

HTTPS 调用

请求地址

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

请求参数

属性类型默认值必填说明
access_tokenstring接口调用凭证
begin_datestring开始日期,为自然月第一天。格式为 yyyymmdd
end_datestring结束日期,为自然月最后一天,限定查询一个月数据。格式为 yyyymmdd

返回值

Object

返回的 JSON 数据包

属性类型说明
ref_datestring时间,如:"201702"
visit_uv_newObject新增用户留存
visit_uvObject活跃用户留存

visit_uv_new 的结构

属性类型说明
keynumber标识,0开始,表示当月,1表示1月后。key取值分别是:0,1
valuenumberkey对应日期的新增用户数/活跃用户数(key=0时)或留存用户数(k>0时)

visit_uv 的结构

属性类型说明
keynumber标识,0开始,表示当月,1表示1月后。key取值分别是:0,1
valuenumberkey对应日期的新增用户数/活跃用户数(key=0时)或留存用户数(k>0时)

注意

请求json和返回json与天的一致,这里限定查询一个自然月的数据,时间必须按照自然月的方式输入: 如:20170201(月初), 20170228(月末)

请求数据示例

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

返回数据示例

  1. {
  2. "ref_date": "201702",
  3. "visit_uv_new": [
  4. {
  5. "key": 0,
  6. "value": 346249
  7. }
  8. ],
  9. "visit_uv": [
  10. {
  11. "key": 0,
  12. "value": 346249
  13. }
  14. ]
  15. }

云调用

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

接口方法

  1. openapi.analysis.getMonthlyRetain

需在 config.json 中配置 analysis.getMonthlyRetain API 的权限,详情

请求参数

属性类型默认值必填说明
beginDatestring开始日期,为自然月第一天。格式为 yyyymmdd
endDatestring结束日期,为自然月最后一天,限定查询一个月数据。格式为 yyyymmdd

返回值

Object

返回的 JSON 数据包

属性类型说明
refDatestring时间,如:"201702"
visitUvNewObject新增用户留存
visitUvObject活跃用户留存

visitUvNew 的结构

属性类型说明
keynumber标识,0开始,表示当月,1表示1月后。key取值分别是:0,1
valuenumberkey对应日期的新增用户数/活跃用户数(key=0时)或留存用户数(k>0时)

visitUv 的结构

属性类型说明
keynumber标识,0开始,表示当月,1表示1月后。key取值分别是:0,1
valuenumberkey对应日期的新增用户数/活跃用户数(key=0时)或留存用户数(k>0时)

请求数据示例

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

返回数据示例

  1. {
  2. "refDate": "201702",
  3. "visitUvNew": [
  4. {
  5. "key": 0,
  6. "value": 346249
  7. }
  8. ],
  9. "visitUv": [
  10. {
  11. "key": 0,
  12. "value": 346249
  13. }
  14. ],
  15. "errMsg": "openapi.analysis.getMonthlyRetain:ok"
  16. }