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

接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考接口调用指南

接口英文名：getMonthlyRetain

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

# 1. 调用方式

# HTTPS 调用

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

支持加密请求： 本接口支持服务通信二次加密和签名，可有效防止数据篡改与泄露。查看详情

# 云调用

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

# 第三方调用

本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为：18
服务商获得其中之一权限集授权后，可通过使用 authorizer_access_token 代商家进行调用，具体可查看第三方调用说明文档。

# 2. 请求参数

# 查询参数 `Query String parameters`

参数名	类型	必填	说明
access_token	string	是	接口调用凭证，可使用 access_token、authorizer_access_token

# 请求体 `Request Payload`

参数名	类型	必填	说明
begin_date	string	是	开始日期，为自然月第一天。格式为 yyyymmdd
end_date	string	是	结束日期，为自然月最后一天，限定查询一个月数据。格式为 yyyymmdd

# 3. 返回参数

# 返回体 `Response Payload`

参数名	类型	说明
ref_date	string	时间，如："201702"
visit_uv_new	objarray	新增用户留存
visit_uv	objarray	活跃用户留存

# Res.visit_uv_new(Array) `Object Payload`

新增用户留存

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

# Res.visit_uv(Array) `Object Payload`

活跃用户留存

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

# 4. 注意事项

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

# 5. 代码示例

# 5.1 HTTPS调用示例

请求示例

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

返回示例

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

# 5.2 云函数调用

请求示例

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"
}

# 6. 错误码

以下是本接口的错误码列表，其他错误码可参考通用错误码；调用接口遇到报错，可使用官方提供的 API 诊断工具辅助定位和分析问题。

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

# 7. 适用范围

本接口在不同账号类型下的可调用情况：

小程序	小游戏
✔	✔

✔：该账号可调用此接口
其他未明确声明的账号类型，如无特殊说明，均不可调用此接口；