# 获取用户增减数据
接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考接口调用指南
接口英文名：getusersummary
本接口用于获取用户增减数据分析数据
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/datacube/getusersummary?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用
# 第三方调用
本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为：2
服务商获得其中之一权限集授权后，可通过使用 authorizer_access_token 代商家进行调用，具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String parameters
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| access_token | string | 是 | 接口调用凭证，可使用 access_token、authorizer_access_token |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 示例 | 说明 |
|---|---|---|---|---|
| begin_date | string | 是 | 2014-12-02 | 起始日期(格式yyyy-MM-dd) |
| end_date | string | 是 | 2014-12-07 | 结束日期(最大跨度7天) |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| list | objarray | 数据列表 |
# Res.list(Array) Object Payload
数据列表
| 参数名 | 类型 | 说明 |
|---|---|---|
| ref_date | string | 数据的日期 |
| user_source | number | 用户的渠道，数值代表的含义如下：0代表其他合计、1代表公众号搜索、17代表名片分享、30代表扫描二维码、57代表文章内账号名称、100代表微信广告、161代表他人转载、149代表小程序关注、200代表视频号、201代表直播 |
| new_user | number | 新增的用户数量 |
| cancel_user | number | 取消关注的用户数量，new_user减去cancel_user即为净增用户数量 |
# 4. 注意事项
- 接口侧数据存储始于2014-12-01
- 建议开发者自行保存数据
- 每日8点后获取前一天数据
- 2020年4月起新增'他人转载'渠道
- 2020年6月起新增'微信广告'等渠道
- 2023年6月起支付后关注计入其他合计
# 5. 代码示例
请求示例
{
"begin_date": "2014-12-02",
"end_date": "2014-12-07"
}
返回示例
{
"list": [
{
"ref_date": "2014-12-07",
"user_source": 0,
"new_user": 0,
"cancel_user": 0
}
]
}
# 6. 错误码
以下是本接口的错误码列表，其他错误码可参考 通用错误码
| 错误码 | 错误描述 | 解决方案 |
|---|---|---|
| -1 | system error | 系统繁忙，此时请开发者稍候再试 |
| 40001 | invalid credential access_token isinvalid or not latest | 获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口 |
| 61500 | date format error | 日期格式错误 |
| 61501 | date range error | 日期跨度超过限制 |
| 61503 | data not ready please try later | 指定日期数据尚未生成 |
# 7. 适用范围
本接口在不同账号类型下的可调用情况：
| 公众号 | 服务号 |
|---|---|
| 仅认证 | 仅认证 |
- 仅认证：表示仅允许企业主体已认证账号调用，未认证或不支持认证的账号无法调用
- 其他未明确声明的账号类型，如无特殊说明，均不可调用此接口；