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

调试工具

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

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

# 接口说明

# 接口英文名

getMonthlyRetain

# 功能描述

该接口用于获取用户访问小程序月留存。

# 注意事项

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

# 调用方式

# HTTPS 调用


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

# 云调用

出入参和HTTPS调用相同，调用方式可查看云调用说明文档
接口方法为: openapi.analysis.getMonthlyRetain

# 第三方调用

调用方式以及出入参和HTTPS相同，仅是调用的token不同
该接口所属的权限集id为：18、21
服务商获得其中之一权限集授权后，可通过使用authorizer_access_token代商家进行调用

# 请求参数

属性	类型	必填	说明
access_token	string	是	接口调用凭证，该参数为 URL 参数，非 Body 参数。使用access_token或者authorizer_access_token
begin_date	string	是	开始日期，为自然月第一天。格式为 yyyymmdd
end_date	string	是	结束日期，为自然月最后一天，限定查询一个月数据。格式为 yyyymmdd

# 返回参数

属性

类型

说明

ref_date

string

时间，如："201702"

visit_uv_new

array<object>

新增用户留存

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

visit_uv

array<object>

活跃用户留存

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

# 调用示例

示例说明: HTTPS调用示例

# 请求数据示例


{
  "begin_date" : "20170201",
  "end_date" : "20170228"
}

# 返回数据示例


{
  "ref_date": "201702",
  "visit_uv_new": [
    {
      "key": 0,
      "value": 346249
    }
  ],
  "visit_uv": [
    {
      "key": 0,
      "value": 346249
    }
  ]
}

示例说明: 云函数调用

# 请求数据示例


const cloud = require('wx-server-sdk')
cloud.init({
  env: cloud.DYNAMIC_CURRENT_ENV,
})
exports.main = async (event, context) => {
  try {
    const result = await cloud.openapi.analysis.getMonthlyRetain({
        "beginDate": '20170201',
        "endDate": '20170228'
      })
    return result
  } catch (err) {
    return err
  }
}

# 返回数据示例


{
  "refDate": "201702",
  "visitUvNew": [
    {
      "key": 0,
      "value": 346249
    }
  ],
  "visitUv": [
    {
      "key": 0,
      "value": 346249
    }
  ],
  "errMsg": "openapi.analysis.getMonthlyRetain:ok"
}

# 错误码

错误码	错误码取值	解决方案
-1	system error	系统繁忙，此时请开发者稍候再试
40001	invalid credential access_token isinvalid or not latest	获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口