# 获取图文群发每日数据

调试工具

接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南

接口英文名:getarticlesummary

本接口用于获取某天所有被阅读过的群发文章当天的阅读数据

# 1. 调用方式

# HTTPS 调用

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

# 云调用

  • 调用方法:officialAccount.datacube.getArticleSummary

  • 出入参和 HTTPS 调用相同,调用方式可查看 云调用 说明文档

# 第三方调用

  • 本接口支持第三方平台代商家调用。

  • 该接口所属的权限集 id 为:7

  • 服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。

# 2. 请求参数

# 查询参数 Query String parameters

参数名类型必填说明
access_tokenstring接口调用凭证,可使用 access_tokenauthorizer_access_token

# 请求体 Request Payload

参数名类型必填示例说明
begin_datestring2023-01-01起始日期(YYYY-MM-DD)
end_datestring2023-01-01结束日期(最大值为昨日)

# 3. 返回参数

# 返回体 Response Payload

参数名类型说明
listobjarray该日期内所有被阅读过的文章(仅包括群发的文章)数据

# Res.list(Array) Object Payload

该日期内所有被阅读过的文章(仅包括群发的文章)数据

参数名类型说明
ref_datestring数据的日期,需在begin_date和end_date之间
msgidstring请注意:这里的msgid实际上是由msgid(图文消息id,这也就是群发接口调用后返回的msg_data_id)和index(消息次序索引)组成, 例如12003_3, 其中12003是msgid,即一次群发的消息的id; 3为index,假设该次群发的图文消息共5个文章(因为可能为多图文),3表示5个中的第3个
titlestring图文消息的标题
int_page_read_usernumber图文页(点击群发图文卡片进入的页面)的阅读人数
int_page_read_countnumber图文页的阅读次数
ori_page_read_usernumber原文页(点击图文页“阅读原文”进入的页面)的阅读人数,无原文页时此处数据为0
ori_page_read_countnumber原文页的阅读次数
share_usernumber分享的人数
share_countnumber分享的次数
add_to_fav_usernumber收藏的人数
add_to_fav_countnumber收藏的次数

# 4. 注意事项

  1. 数据存储起始时间为2014-12-01,之前日期数据无效
  2. 建议开发者本地缓存数据
  3. 阅读量总和≥3的图文才会被统计
  4. 建议每日8点后查询前一天数据
  5. 2020年2月28日起新增传播渠道字段

# 5. 代码示例

请求示例

{
  "begin_date": "2014-12-08",
  "end_date": "2014-12-08"
}

返回示例

{
  "list": [
    {
      "ref_date": "2014-12-08",
      "msgid": "10000050_1",
      "title": "12月27日 DiLi日报",
      "int_page_read_user": 23676,
      "int_page_read_count": 25615,
      "ori_page_read_count": 34,
      "share_user": 122,
      "share_count": 994,
      "add_to_fav_user": 1
    }
  ]
}

# 6. 错误码

以下是本接口的错误码列表,其他错误码可参考 通用错误码

错误码错误描述解决方案
-1system error系统繁忙,此时请开发者稍候再试
0ok成功
40001invalid credential  access_token isinvalid or not latest获取 access_token 时 AppSecret 错误,或者 access_token 无效。请开发者认真比对 AppSecret 的正确性,或查看是否正在为恰当的公众号调用接口
61500date range error日期范围超过接口限制

# 7. 适用范围

本接口在不同账号类型下的可调用情况:
公众号服务号
仅认证 仅认证
  • 仅认证:表示仅允许企业主体已认证账号调用,未认证或不支持认证的账号无法调用
  • 其他未明确声明的账号类型,如无特殊说明,均不可调用此接口;