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

[调试诊断](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_tools)

> 接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考[接口调用指南](/doc/oplatform/developers/dev/guide.md)。

接口英文名：getMonthlyVisitTrend

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

## 1. 调用方式

### HTTPS 调用

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

> **支持加密请求：** 本接口支持服务通信二次加密和签名，可有效防止数据篡改与泄露。[查看详情](/miniprogram/dev/server/getting_started/api_signature)

### 云调用

- 调用方法：analysis.getMonthlyVisitTrend

- 出入参和 HTTPS 调用相同，调用方式可查看 [云调用](/doc/oplatform/developers/dev/cloudCall.md) 说明文档。

### 第三方调用

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

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

- 服务商获得其中之一权限集授权后，可通过使用 [authorizer_access_token](/doc/oplatform/developers/dev/AuthorizerAccessToken.md) 代商家进行调用，具体可查看 [第三方调用](/doc/oplatform/Third-party_Platforms/2.0/Before_Develop/call_interface.md) 说明文档。

## 2. 请求参数

### 查询参数 `Query String Parameters`

```json
[
  {
    "参数名": "access_token",
    "类型": "string",
    "必填": "是",
    "说明": "接口调用凭证，可使用 [access_token](/miniprogram/dev/server/API/mp-access-token/api_getaccesstoken)、[authorizer_access_token](/doc/oplatform/openApi/ticket-token/api_getauthorizeraccesstoken.md)"
  }
]
```

### 请求体 `Request Payload`

```json
[
  {
    "参数名": "begin_date",
    "类型": "string",
    "必填": "是",
    "说明": "开始日期，为自然月第一天。格式为 yyyymmdd"
  },
  {
    "参数名": "end_date",
    "类型": "string",
    "必填": "是",
    "说明": "结束日期，为自然月最后一天，限定查询一个月的数据。格式为 yyyymmdd"
  }
]
```

## 3. 返回参数

### 返回体 `Response Payload`

```json
[
  {
    "参数名": "list",
    "类型": "objarray",
    "说明": "数据列表"
  }
]
```

">

### Res.list(Array) `Object Payload`

数据列表

```json
[
  {
    "参数名": "ref_date",
    "类型": "string",
    "说明": "时间，格式为 yyyymm，如：\"201702\""
  },
  {
    "参数名": "session_cnt",
    "类型": "number",
    "说明": "打开次数（自然月内汇总）"
  },
  {
    "参数名": "visit_pv",
    "类型": "number",
    "说明": "访问次数（自然月内汇总）"
  },
  {
    "参数名": "visit_uv",
    "类型": "number",
    "说明": "访问人数（自然月内去重）"
  },
  {
    "参数名": "visit_uv_new",
    "类型": "number",
    "说明": "新用户数（自然月内去重）"
  },
  {
    "参数名": "stay_time_uv",
    "类型": "number",
    "说明": "人均停留时长 (浮点型，单位：秒)"
  },
  {
    "参数名": "stay_time_session",
    "类型": "number",
    "说明": "次均停留时长 (浮点型，单位：秒)"
  },
  {
    "参数名": "visit_depth",
    "类型": "number",
    "说明": "平均访问深度 (浮点型)"
  }
]
```

## 4. 注意事项

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

## 5. 代码示例

### 5.1 HTTPS调用

请求示例

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

返回示例

```json
{
  "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 云函数调用

请求示例

```json
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
  }
}
```

返回示例

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

## 6. 错误码

以下是本接口的错误码列表，其他错误码可参考 [通用错误码](/doc/oplatform/developers/errCode/README.md)；调用接口遇到报错，可使用官方提供的 [API 诊断工具](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_errcode) 辅助定位和分析问题。

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

## 7. 适用范围

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

```json
[
  {
    "小程序": "✔",
    "小游戏": "✔"
  }
]
```

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