# analysis.getWeeklyRetain

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

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

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

调用方式:

# HTTPS 调用

# 请求地址

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

# 请求参数

属性 类型 默认值 必填 说明
access_token / cloudbase_access_token string 接口调用凭证
begin_date string 开始日期,为周一日期。格式为 yyyymmdd
end_date string 结束日期,为周日日期,限定查询一周数据。格式为 yyyymmdd

# 返回值

# Object

返回的 JSON 数据包

属性 类型 说明
ref_date string 时间,如:"20170306-20170312"
visit_uv_new Object 新增用户留存
visit_uv Object 活跃用户留存

visit_uv_new 的结构

属性 类型 说明
key number 标识,0开始,表示当周,1表示1周后。依此类推,取值分别是:0,1,2,3,4
value number key对应日期的新增用户数/活跃用户数(key=0时)或留存用户数(k>0时)

visit_uv 的结构

属性 类型 说明
key number 标识,0开始,表示当周,1表示1周后。依此类推,取值分别是:0,1,2,3,4
value number key对应日期的新增用户数/活跃用户数(key=0时)或留存用户数(k>0时)

# 注意

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

# 请求数据示例

{
  "begin_date" : "20170306",
  "end_date" : "20170312"
}

# 返回数据示例

{
  "ref_date": "20170306-20170312",
  "visit_uv_new": [
    {
      "key": 0,
      "value": 0
    },
    {
      "key": 1,
      "value": 16853
    }
  ],
  "visit_uv": [
    {
      "key": 0,
      "value": 0
    },
    {
      "key": 1,
      "value": 99310
    }
  ]
}

# 云调用

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

# 接口方法

openapi.analysis.getWeeklyRetain

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

# 请求参数

属性 类型 默认值 必填 说明
beginDate string 开始日期,为周一日期。格式为 yyyymmdd
endDate string 结束日期,为周日日期,限定查询一周数据。格式为 yyyymmdd

# 返回值

# Object

返回的 JSON 数据包

属性 类型 说明
refDate string 时间,如:"20170306-20170312"
visitUvNew Object 新增用户留存
visitUv Object 活跃用户留存

visitUvNew 的结构

属性 类型 说明
key number 标识,0开始,表示当周,1表示1周后。依此类推,取值分别是:0,1,2,3,4
value number key对应日期的新增用户数/活跃用户数(key=0时)或留存用户数(k>0时)

visitUv 的结构

属性 类型 说明
key number 标识,0开始,表示当周,1表示1周后。依此类推,取值分别是:0,1,2,3,4
value number key对应日期的新增用户数/活跃用户数(key=0时)或留存用户数(k>0时)

# 请求数据示例

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.getWeeklyRetain({
        "beginDate": '20170306',
        "endDate": '20170312'
      })
    return result
  } catch (err) {
    return err
  }
}

# 返回数据示例

{
  "refDate": "20170306-20170312",
  "visitUvNew": [
    {
      "key": 0,
      "value": 0
    },
    {
      "key": 1,
      "value": 16853
    }
  ],
  "visitUv": [
    {
      "key": 0,
      "value": 0
    },
    {
      "key": 1,
      "value": 99310
    }
  ],
  "errMsg": "openapi.analysis.getWeeklyRetain:ok"
}