# Get user increase and decrease data

Debugging Tools

Interface should be called on the server side, not in the front end (Weixin Mini Program, web pages, APP, etc.) directly called, specific reference interface call guide

Interface name: getusersummary

This interface is used to obtain user incremental and subtraction data analysis data

# 1. How to call

# HTTPS calls

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

# Cloud Calls

  • This interface does not support cloud calls

# Third party invocation

  • This interface supports Third Party Platform generation business call.

  • The permission set id to which the interface belongs is: 2

  • When a service provider is authorized by one of the permissions set, it can call on behalf of the merchant by using authorizer_access_token , which can be viewed in the third-party call documentation.

# 2. Request parameters

# Query parametersQuery String parameters

Parameter NametypeRequired to fill inIntroductions
access_tokenstringyesInterface invocation credentials, using access_token , authorizer_access_token

# Request BodyRequest Payload

Parameter NametypeRequired to fill inExampleIntroductions
begin_datestringyes2014-12-02Start date (format yyyy-MM-dd)
end_datestringyes2014-12-07End date (maximum span of 7 days)

# 3. Return Parameters

# Response Payload

Parameter NametypeIntroductions
listobjarrayList of data

# Res.list(Array)Object Payload

List of data

Parameter NametypeIntroductions
ref_datestringDate of data
user_sourcenumberThe user's channel, a numerical value represents the following meaning: 0 represents the other sum, 1 representsOfficial Account Search, 17 represents business card sharing, 30 represents scanning a QR code, 57 represents the account name within an article, 100 represents WeChat advertisements, 161 represents reposts by others, 149 represents Weixin Mini Program subscriptions, 200 represents WeChat Channels, and 201 represents live broadcasts.
new_usernumberNumber of new users
cancel_usernumberThe number of unfollowed users, new_user minus cancel_user is the net increase in the number of users

# 4. Note

  1. Interface side data storage started on 2014-12-01
  2. Developers are advised to save data on their own
  3. Get the previous day's data after 8: 00 a.m.
  4. New channels for 'people to reprint' from April 2020
  5. New channels such as "WeChat advertising" from June 2020
  6. After payment concerns are counted into other combined amounts starting June 2023

# 5. Code examples

Example Requests

{
  "begin_date": "2014-12-02",
  "end_date": "2014-12-07"
}

Return an example

{
  "list": [
    {
      "ref_date": "2014-12-07",
      "user_source": 0,
      "new_user": 0,
      "cancel_user": 0
    }
  ]
}

# 6. Error code

The following is a list of error codes for this interface, other error codes can refer to General error codes

Error codeError DescriptionSolutions
-1system errorThe system is busy, so the developer is asked to try again in a few minutes.
40001invalid credential  access_token isinvalid or not latestAppSecret error while getting access_token, or access_token is invalid.Developers should check that AppSecret is correct, or that they are calling interfaces for the appropriate Official Account
61500date format errorDate format error
61501date range errorDate span exceeds limit
61503data not ready  please try laterData for the specified date has not yet been generated

# 7. Scope of application

How this interface can be invoked under different account types:
Official Account Service Account
Certification only Certification only
  • Authentication only: means that only authenticated accounts are allowed to be invoked by the enterprise entity, and accounts that are not authenticated or do not support authentication cannot be invoked.
  • Other account types that are not expressly stated may not be called on this interface without special instructions;