# 获取用户访问小程序数据月趋势

调试诊断

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

接口英文名:getMonthlyVisitTrend

该接口用于获取用户访问小程序数据月趋势(能查询到的最新数据为上一个自然月的数据)。

# 1. 调用方式

# HTTPS 调用

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

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

# 云调用

  • 调用方法:analysis.getMonthlyVisitTrend

  • 出入参和 HTTPS 调用相同,调用方式可查看 云调用 说明文档

# 第三方调用

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

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

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

# 2. 请求参数

# 查询参数 Query String parameters

参数名类型必填说明
access_tokenstring接口调用凭证,可使用 access_tokenauthorizer_access_token

# 请求体 Request Payload

参数名类型必填说明
begin_datestring开始日期,为自然月第一天。格式为 yyyymmdd
end_datestring结束日期,为自然月最后一天,限定查询一个月的数据。格式为 yyyymmdd

# 3. 返回参数

# 返回体 Response Payload

参数名类型说明
listobjarray数据列表

# Res.list(Array) Object Payload

数据列表

参数名类型说明
ref_datestring时间,格式为 yyyymm,如:"201702"
session_cntnumber打开次数(自然月内汇总)
visit_pvnumber访问次数(自然月内汇总)
visit_uvnumber访问人数(自然月内去重)
visit_uv_newnumber新用户数(自然月内去重)
stay_time_uvnumber人均停留时长 (浮点型,单位:秒)
stay_time_sessionnumber次均停留时长 (浮点型,单位:秒)
visit_depthnumber平均访问深度 (浮点型)

# 4. 注意事项

限定查询一个自然月的数据,时间必须按照自然月的方式输入: 如:20170301, 20170331

# 5. 代码示例

# 5.1 HTTPS调用

请求示例

{
  "begin_date": "20170301",
  "end_date": "20170331"
}

返回示例

{
  "list": [
    {
      "ref_date": "201703",
      "session_cnt": 126513,
      "visit_pv": 426113,
      "visit_uv": 48659,
      "visit_uv_new": 6726,
      "stay_time_session": 56.4112,
      "visit_depth": 2.0189
    }
  ]
}

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

返回示例

{
  "list": [
    {
      "refDate": "201703",
      "sessionCnt": 126513,
      "visitPv": 426113,
      "visitUv": 48659,
      "visitUvNew": 6726,
      "stayTimeSession": 56.4112,
      "visitDepth": 2.0189
    }
  ],
  "errMsg": "openapi.analysis.getMonthlyVisitTrend:ok"
}

# 6. 错误码

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

错误码错误描述解决方案
40001invalid credential  access_token isinvalid or not latest获取 access_token 时 AppSecret 错误,或者 access_token 无效。请开发者认真比对 AppSecret 的正确性,或查看是否正在为恰当的公众号调用接口

# 7. 适用范围

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