# 获取图文阅读概况数据

[调试诊断](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_tools)

> 接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考[接口调用指南](/doc/oplatform/developers/dev/guide.md)。

接口英文名：getuserread

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

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

**注意：本接口已停止维护，请尽快使用下面新接口进行替换**：

[获取发表内容每日阅读数据](api_getarticleread)

[获取发表内容每日分享数据](api_getarticleshare)

[获取发表内容概况总数据](api_getbizsummary)

[获取发表内容发表详细数据](api_getarticletotaldetail)

## 1. 调用方式

### HTTPS 调用

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

### 云调用

- 调用方法：officialAccount.datacube.getUserRead

- 出入参和 HTTPS 调用相同，调用方式可查看 [云调用](/doc/oplatform/developers/dev/cloudCall.md) 说明文档。

### 第三方调用

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

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

- 服务商获得其中之一权限集授权后，可通过使用 [authorizer_access_token](/doc/oplatform/developers/dev/AuthorizerAccessToken.md) 代商家进行调用，具体可查看 [第三方调用](/doc/oplatform/Third-party_Platforms/2.0/Before_Develop/call_interface.md) 说明文档。

## 2. 请求参数

### 查询参数 `Query String Parameters`

```json
[
  {
    "参数名": "access_token",
    "类型": "string",
    "必填": "是",
    "说明": "接口调用凭证，可使用 [access_token](/doc/service/api/base/api_getaccesstoken)、[authorizer_access_token](/doc/oplatform/openApi/ticket-token/api_getauthorizeraccesstoken.md)"
  }
]
```

### 请求体 `Request Payload`

```json
[
  {
    "参数名": "begin_date",
    "类型": "string",
    "必填": "是",
    "示例": "2023-01-01",
    "说明": "起始日期(YYYY-MM-DD)"
  },
  {
    "参数名": "end_date",
    "类型": "string",
    "必填": "是",
    "示例": "2023-01-01",
    "说明": "结束日期(最大值为昨日)"
  }
]
```

## 3. 返回参数

### 返回体 `Response Payload`

```json
[
  {
    "参数名": "list",
    "类型": "objarray",
    "说明": "数据列表"
  }
]
```

">

### Res.list(Array) `Object Payload`

数据列表

```json
[
  {
    "参数名": "ref_date",
    "类型": "string",
    "说明": "数据的日期，需在begin_date和end_date之间"
  },
  {
    "参数名": "user_source",
    "类型": "number",
    "说明": "用户从哪里进入来阅读该图文。99999999.全部；0:会话;1.好友;2.朋友圈;4.历史消息页;5.其他;6.看一看;7.搜一搜；"
  },
  {
    "参数名": "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",
    "说明": "收藏的次数"
  }
]
```

## 4. 注意事项

本接口无特殊注意事项

## 5. 代码示例

请求示例

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

返回示例

``` json
{ 
   "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. 错误码

以下是本接口的错误码列表，其他错误码可参考 [通用错误码](/doc/oplatform/developers/errCode/README.md)；调用接口遇到报错，可使用官方提供的 [API 诊断工具](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_errcode) 辅助定位和分析问题。

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

## 7. 适用范围

本接口在不同账号类型下的可调用情况：

```json
[
  {
    "公众号": "仅认证",
    "服务号": "仅认证"
  }
]
```

- 仅认证：表示仅允许企业主体已认证账号调用，未认证或不支持认证的账号无法调用。
- 其他未明确声明的账号类型，如无特殊说明，均不可调用此接口。