# Get aggregate user data
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: getusercumulate
This interface is used to obtain user aggregated data analysis data
# 1. How to call
# HTTPS calls
POST https://api.weixin.qq.com/datacube/getusercumulate?access_token=ACCESS_TOKEN
# Cloud Calls
Call method: officialAccount.datacube.getUserCumulate
The input and exit parameters are the same as the HTTPS call, which can be called in the cloud call documentation
# 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 Name | type | Required to fill in | Introductions |
---|---|---|---|
access_token | string | yes | Interface invocation credentials, using access_token , authorizer_access_token |
# Request BodyRequest Payload
Parameter Name | type | Required to fill in | Example | Introductions |
---|---|---|---|---|
begin_date | string | yes | 2014-12-02 | Start date (format yyyy-MM-dd) |
end_date | string | yes | 2014-12-07 | End date (maximum span of 7 days) |
# 3. Return Parameters
# Response Payload
Parameter Name | type | Introductions |
---|---|---|
list | object | List of data |
# Res.listObject Payload
List of data
Parameter Name | type | Introductions |
---|---|---|
ref_date | string | Date of data |
cumulate_user | number | Total number of users |
# 4. Note
- Interface side data storage started on 2014-12-01
- Developers are advised to save data on their own
- Get the previous day's data after 8: 00 a.m.
- New channels for 'people to reprint' from April 2020
- New channels such as "WeChat advertising" from June 2020
- 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",
"cumulate_user": 1217056
}
]
}
# 6. Error code
The following is a list of error codes for this interface, other error codes can refer to General error codes
Error code | Error Description | Solutions |
---|---|---|
-1 | system error | The system is busy, so the developer is asked to try again in a few minutes. |
40001 | invalid credential access_token isinvalid or not latest | AppSecret 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 |
61500 | date format error | Date format error |
61501 | date range error | Date span exceeds limit |
61503 | data not ready please try later | Data for the specified date has not yet been generated |
# 7. Scope of application
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;