公众号
取消
中文
中文
EN
取消
  • 服务端 API

    • # 获取图文阅读概况数据

    调试工具

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

    接口英文名：getuserread

    本接口用于获取图文阅读概括数据。

    2020年2月28日起，中间页阅读、分享统一提供user_source字段，用于区分<传播渠道>与<全部>数据，详情请见文档底部参数说明；原文页阅读、收藏只提供<全部渠道>数据

    # 1. 调用方式

    # HTTPS 调用

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

    # 云调用

    • 调用方法：officialAccount.datacube.getUserRead

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

    # 第三方调用

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

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

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

    # 2. 请求参数

    # 查询参数 Query String parameters

    参数名类型必填说明
    access_tokenstring是接口调用凭证，可使用 access_token、authorizer_access_token

    # 请求体 Request Payload

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

    # 3. 返回参数

    # 返回体 Response Payload

    参数名类型说明
    listobjarray数据列表

    # Res.list(Array) Object Payload

    数据列表

    参数名类型说明
    ref_datestring数据的日期，需在begin_date和end_date之间
    user_sourcenumber用户从哪里进入来阅读该图文。99999999.全部；0:会话;1.好友;2.朋友圈;4.历史消息页;5.其他;6.看一看;7.搜一搜；
    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. 注意事项

    本接口无特殊注意事项

    # 5. 代码示例

    请求示例

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

    返回示例

    { 
   "list": [ 
       { 
           "ref_date": "2020-02-18", 
           "user_source":99999999
           "int_page_read_user": 545497, 
           "int_page_read_count": 856093, 
           "ori_page_read_user": 191, 
           "ori_page_read_count": 240, 
           "share_user": 22603, 
           "share_count": 28487, 
           "add_to_fav_user": 3163, 
           "add_to_fav_count": 3841
       },
       { 
           "ref_date": "2020-02-18", 
           "user_source":0
           "int_page_read_user": 381272, 
           "int_page_read_count": 646629, 
           "ori_page_read_user": 0, 
           "ori_page_read_count": 0, 
           "share_user": 13110, 
           "share_count": 16469, 
           "add_to_fav_user": 0, 
           "add_to_fav_count": 0
       }
   ]
}

    # 6. 错误码

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

    错误码错误描述解决方案
    -1system error系统繁忙，此时请开发者稍候再试
    40001invalid credential  access_token isinvalid or not latest获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口

    # 7. 适用范围

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