# analysis.getMonthlyRetain

Call this API at the server side. For more information, see Server API.

This API supports Cloud Calls. The WeChat DevTools version must be 1.02.1904090 or later (download the latest stable version here), and the wx-server-sdk version must be 0.4.0 or later.

Obtains the monthly retention of user visits to a Mini Program.

Calling methods:

• HTTPS call
• Cloud call

# HTTPS Call

# Request Address

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

# Request Parameters

# Return Value

# Object

JSON data package that is returned

visit_uv_new is composed as follows

visit_uv is composed as follows

# Notes

The properties of the request JSON data packet and the returned JSON data packet are the same as those for the getDailyVisitTrend API. Here, only the data of one natural month can be queried, and the time must be entered according to the natural month, for example, 20170201 (beginning of month) and 20170228 (end of month).

# Request Data Example

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

# Return Data Example

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

# Cloud Call

Cloud call is a capability provided by Mini Program·Cloud Base that allows you to call WeChat APIs in a cloud function. It must be used via wx-server-sdk in the cloud function.

# API Calling Method

openapi.analysis.getMonthlyRetain

You need to configure the permissions for the analysis.getMonthlyRetain API via config.json. Details

# Request Parameters

# Return Value

# Object

JSON data package that is returned

visitUvNew is composed as follows

visitUv is composed as follows

# Request Data Example

const cloud = require('wx-server-sdk')
  cloud.init()
  exports.main = async (event, context) => {
    try {
      const result = await cloud.openapi.analysis.getMonthlyRetain({
        beginDate: '20170201',
        endDate: '20170228'
      })
      console.log(result)
      return result
    } catch (err) {
      console.log(err)
      return err
    }
  }

# Return Data Example

{
  "refDate": "201702",
  "visitUvNew": [
    {
      "key": 0,
      "value": 346249
    }
  ],
  "visitUv": [
    {
      "key": 0,
      "value": 346249
    }
  ],
  "errMsg": "openapi.analysis.getMonthlyRetain:ok"
}