小程序
取消
开发
中文
EN
取消
  • 指南

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

    调试诊断

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

    接口英文名：getDailyRetain

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

    # 1. 调用方式

    # HTTPS 调用

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

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

    # 云调用

    • 本接口不支持云调用

    # 第三方调用

    • 本接口支持第三方平台代商家调用。

    • 该接口所属的权限集 id 为：18

    • 服务商获得其中之一权限集授权后，可通过使用 authorizer_access_token 代商家进行调用，具体可查看 第三方调用 说明文档。

    # 2. 请求参数

    # 查询参数 Query String parameters

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

    # 请求体 Request Payload

    参数名类型必填说明
    begin_datestring是开始日期。格式为 yyyymmdd
    end_datestring是结束日期，限定查询1天数据，允许设置的最大值为昨日。格式为 yyyymmdd

    # 3. 返回参数

    # 返回体 Response Payload

    参数名类型说明
    ref_datestring日期
    visit_uv_newobjarray新增用户留存
    visit_uvobjarray活跃用户留存

    # Res.visit_uv_new(Array) Object Payload

    新增用户留存

    参数名类型说明
    keynumber标识，0开始，表示当天，1表示1天后。依此类推，key取值分别是：0,1,2,3,4,5,6,7,14,30
    valuenumberkey对应日期的新增用户数/活跃用户数（key=0时）或留存用户数（k>0时）

    # Res.visit_uv(Array) Object Payload

    活跃用户留存

    参数名类型说明
    keynumber标识，0开始，表示当天，1表示1天后。依此类推，key取值分别是：0,1,2,3,4,5,6,7,14,30
    valuenumberkey对应日期的新增用户数/活跃用户数（key=0时）或留存用户数（k>0时）

    # 4. 注意事项

    本接口无特殊注意事项

    # 5. 代码示例

    # 5.1 HTTPS请求

    请求示例

    {
  "begin_date": "20170313",
  "end_date": "20170313"
}

    返回示例

    {
  "ref_date": "20170313",
  "visit_uv_new": [
    {
      "key": 0,
      "value": 5464
    }
  ],
  "visit_uv": [
    {
      "key": 0,
      "value": 55500
    }
  ]
}

    # 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.getDailyRetain({
        "beginDate": '20170313',
        "endDate": '20170313'
      })
    return result
  } catch (err) {
    return err
  }
}

    返回示例

    {
  "refDate": "20170313",
  "visitUvNew": [
    {
      "key": 0,
      "value": 5464
    }
  ],
  "visitUv": [
    {
      "key": 0,
      "value": 55500
    }
  ],
  "errMsg": "openapi.analysis.getDailyRetain:ok"
}

    # 6. 错误码

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

    错误码错误描述解决方案
    -1system error系统繁忙，此时请开发者稍候再试

    # 7. 适用范围

    本接口在不同账号类型下的可调用情况：
    小程序小游戏
    ✔ ✔
    • ✔：该账号可调用此接口
    • 其他未明确声明的账号类型，如无特殊说明，均不可调用此接口；