# 获取图文群发总数据
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南
接口英文名:getarticletotal
获取群发文章从群发日起的总量统计数据
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/datacube/getarticletotal?access_token=ACCESS_TOKEN
# 云调用
调用方法:officialAccount.datacube.getArticleTotal
出入参和 HTTPS 调用相同,调用方式可查看 云调用 说明文档
# 第三方调用
本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为:7
服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String parameters
参数名 | 类型 | 必填 | 示例 | 说明 |
---|---|---|---|---|
access_token | string | 是 | ACCESS_TOKEN | 接口调用凭证,可使用 access_token、authorizer_access_token |
# 请求体 Request Payload
参数名 | 类型 | 必填 | 示例 | 说明 |
---|---|---|---|---|
begin_date | string | 是 | 2023-01-01 | 起始日期(YYYY-MM-DD) |
end_date | string | 是 | 2023-01-01 | 结束日期(最大值为昨日) |
# 3. 返回参数
# 返回体 Response Payload
参数名 | 类型 | 说明 |
---|---|---|
list | objarray | 数据列表 |
# Res.list(Array) Object Payload
数据列表
参数名 | 类型 | 说明 |
---|---|---|
stat_date | string | 统计的日期,在getarticletotal接口中,ref_date指的是文章群发出日期, 而stat_date是数据统计日期 |
target_user | number | 送达人数,一般约等于总粉丝数(需排除黑名单或其他异常情况下无法收到消息的粉丝) |
int_page_read_user | number | 图文页(点击群发图文卡片进入的页面)的阅读人数 |
int_page_read_count | number | 图文页的阅读次数 |
ori_page_read_user | number | 原文页(点击图文页“阅读原文”进入的页面)的阅读人数,无原文页时此处数据为0 |
ori_page_read_count | number | 原文页的阅读次数 |
share_user | number | 分享的人数 |
share_count | number | 分享的次数 |
add_to_fav_user | number | 收藏的人数 |
add_to_fav_count | number | 收藏的次数 |
int_page_from_session_read_user | number | 公众号会话阅读人数 |
int_page_from_session_read_count | number | 公众号会话阅读次数 |
int_page_from_hist_msg_read_user | number | 历史消息页阅读人数 |
int_page_from_hist_msg_read_count | number | 历史消息页阅读次数 |
int_page_from_feed_read_user | number | 朋友圈阅读人数 |
int_page_from_feed_read_count | number | 朋友圈阅读次数; |
int_page_from_friends_read_user | number | 好友转发阅读人数 |
int_page_from_friends_read_count | number | 好友转发阅读次数 |
int_page_from_other_read_user | number | 其他场景阅读人数 |
int_page_from_other_read_count | number | 其他场景阅读次数 |
feed_share_from_session_user | number | 公众号会话转发朋友圈人数 |
feed_share_from_session_cnt | number | 公众号会话转发朋友圈次数 |
feed_share_from_feed_user | number | 朋友圈转发朋友圈人数 |
feed_share_from_feed_cnt | number | 朋友圈转发朋友圈次数 |
feed_share_from_other_user | number | 其他场景转发朋友圈人数 |
feed_share_from_other_cnt | number | 其他场景转发朋友圈次数 |
int_page_from_kanyikan_read_user | number | 看一看来源阅读人数 |
int_page_from_kanyikan_read_count | number | 看一看来源阅读次数 |
int_page_from_souyisou_read_user | number | 搜一搜来源阅读人数 |
int_page_from_souyisou_read_count | number | 搜一搜来源阅读次数 |
# 4. 注意事项
details中,每天对应的数值为该文章到该日为止的总量(而不是当日的量)
额外需要注意获取图文群发每日数据(getarticlesummary)和获取图文群发总数据(getarticletotal)的区别如下:
- 前者获取的是某天所有被阅读过的文章(仅包括群发的文章)在当天的阅读次数等数据。
- 后者获取的是,某天群发的文章,从群发日起到接口调用日(但最多统计发表日后7天数据),每天的到当天的总等数据。例如某篇文章是12月1日发出的,发出后在1日、2日、3日的阅读次数分别为1万,则getarticletotal获取到的数据为,距发出到12月1日24时的总阅读量为1万,距发出到12月2日24时的总阅读量为2万,距发出到12月3日24时的总阅读量为3万。
# 5. 代码示例
请求示例
{
"begin_date": "2014-12-08",
"end_date": "2014-12-08"
}
返回示例
{
"list": [
{
"ref_date": "2014-12-14",
"msgid": "202457380_1",
"title": "马航丢画记",
"details": [
{
"stat_date": "2014-12-14",
"target_user": 261917,
"int_page_read_user": 23676,
"int_page_read_count": 25615,
"ori_page_read_user": 29,
"ori_page_read_count": 34,
"share_user": 122,
"share_count": 994,
"add_to_fav_user": 1,
"add_to_fav_count": 3,
"int_page_from_session_read_user": 657283,
"int_page_from_session_read_count": 753486,
"int_page_from_hist_msg_read_user": 1669,
"int_page_from_hist_msg_read_count": 1920,
"int_page_from_feed_read_user": 367308,
"int_page_from_feed_read_count": 433422,
"int_page_from_friends_read_user": 15428,
"int_page_from_friends_read_count": 19645,
"int_page_from_other_read_user": 477,
"int_page_from_other_read_count": 703,
"feed_share_from_session_user": 63925,
"feed_share_from_session_cnt": 66489,
"feed_share_from_feed_user": 18249,
"feed_share_from_feed_cnt": 19319,
"feed_share_from_other_user": 731,
"feed_share_from_other_cnt": 775
}, //后续还会列出所有stat_date符合“ref_date(群发的日期)到接口调用日期”(但最多只统计7天)的数据
]
},//后续还有ref_date(群发的日期)在begin_date和end_date之间的群发文章的数据
]
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码
错误码 | 错误描述 | 解决方案 |
---|---|---|
-1 | system error | 系统繁忙,此时请开发者稍候再试 |
40001 | invalid credential access_token isinvalid or not latest | 获取 access_token 时 AppSecret 错误,或者 access_token 无效。请开发者认真比对 AppSecret 的正确性,或查看是否正在为恰当的公众号调用接口 |
# 7. 适用范围
本接口在不同账号类型下的可调用情况:
公众号 | 服务号 |
---|---|
仅认证 | 仅认证 |
- 仅认证:表示仅允许企业主体已认证账号调用,未认证或不支持认证的账号无法调用
- 其他未明确声明的账号类型,如无特殊说明,均不可调用此接口;