技术文档

# 机构合作数据 API

# 查询书籍维度数据

简要描述： 按日/周返回二级分类的阅读排名, 按月可返回按 [二级分类/三级分类/书籍/加书架] 的排名

请求方式：GET（HTTPS）

请求地址：

https://cpapi-i.yuewen.com/wxhz/getreaddatabybook

请求参数：（查看通用请求参数）

请求参数 必须 类型 说明
date_type 是 string 日期类型 日:day 周:week 月:month
start_time 是 int 开始时间戳（单位：秒）
end_time 是 int 结束时间戳（单位：秒）
page 是 int 页码（从1开始）

返回字段：（查看通用返回字段）

接口字段 类型 说明
statis_day int 日期（按周是statis_week,按月是statis_month）
appflag string 合作方唯一标识
categoryname string 书籍二级分类名称
read_uv int 阅读用户数
read_rank int 阅读用户数排名
data_type int 榜单类型: 0 二级分类排名; 1:阅读人数top10三级分类分布,2:阅读人数top100书籍,3:加入书架top100 书籍(举例：如果为1，则表示是三级分类的榜单，关注subcategoryname字段，其他字段可能为null）
subcategoryid int 三级分类id
subcategoryname string 三级分类名称
title string 书名

请求示例：

https://cpapi-i.yuewen.com/wxhz/getreaddatabybook?appflag=xxx&timestamp=xxx&date_type=day&start_time=xxx&end_time=xxx&page=1&sign=XXX

返回示例：

{
  "code": 0,
  "msg": "成功",
  "data": [
    {
      "statis_day": 20210428,
      "categoryname": "政治",
      "read_uv": 1,
      "read_rank": 1,
      "appflag": "test",
      "data_type": 0,
      "subcategoryid": 0,
      "subcategoryname": "",
      "title": ""
    },
    {
      "statis_day": 20210428,
      "categoryname": "文学",
      "read_uv": 4,
      "read_rank": 2,
      "appflag": "test",
      "data_type": 0,
      "subcategoryid": 0,
      "subcategoryname": "",
      "title": ""
    }
  ]
}

# 查询用户维度数据

简要描述： 按日/周/月返回用户维度的汇总统计数据

请求方式：GET（HTTPS）

请求地址：

https://cpapi-i.yuewen.com/wxhz/getreaddatabyuser

请求参数：（查看通用请求参数）

请求参数 必须 类型 说明
date_type 是 string 日期类型 日:day 周:week 月:month
start_time 是 int 开始时间戳（单位：秒）
end_time 是 int 结束时间戳（单位：秒）
page 是 int 页码（从1开始）

返回字段：（查看通用返回字段）

参数名 类型 说明
statis_day int 日期（按周是statis_week,按月是statis_month）
appflag string 合作方唯一标识
uv int uv
read_uv int 阅读人数
read_book_number int 阅读书目次数
read_book_count int 阅读书本数
read_category_count int 阅读二级分类数
avg_user_read_duration double 人均总阅读时长（秒）
avg_user_read_book_count double 人均阅读书目数

day类型额外字段：

参数名 类型 说明
chapter_cnt int 日阅读章节数
added_books int 日加书架书数
added_uv int 加书架人数
new_uv int 日消耗license数量
avg_read_chapters double 日均阅读章节数

month类型额外字段：

参数名 类型 说明
dau int 该月平均每日访问用户数
chapter_cnt int 月阅读章节人次
added_books long 月加书架书数
added_uv int 月加书架人数
new_uv int 月消耗license数量
avg_read_duration double 人均日均阅读时长
avg_read_books double 人均日均阅读书籍数
avg_read_chapters double 人均日均阅读章节数

请求示例：

https://cpapi-i.yuewen.com/wxhz/getreaddatabyuser?appflag=xxx&timestamp=xxx&date_type=day&start_time=xxx&end_time=xxx&page=1&sign=XXX

返回示例：

{
  "code": 0,
  "msg": "成功",
  "data": {
    "statis_day": 20210428,
    "appflag": "xxx",
    "uv": 11,
    "read_uv": 9,
    "read_book_number": 20,
    "read_book_count": 19,
    "read_category_count": 12,
    "avg_user_read_duration": 2529.80,
    "avg_user_read_book_count": 1.82
  }
}

# 查询具体用户数据

简要描述： 按日/周/月返回具体用户的统计数据

请求方式：GET（HTTPS）

请求地址：

https://cpapi-i.yuewen.com/wxhz/getdatabyopenid

请求参数：（查看通用请求参数）

请求参数 必须 类型 说明
date_type 是 string 日期类型 日:day 周:week 月:month
start_time 是 int 开始时间戳（单位：秒）
end_time 是 int 结束时间戳（单位：秒）
page 是 int 页码（从1开始）
openid 是 string 用户openid

返回字段：（查看通用返回字段）

接口字段 类型 说明
statis_day int 日期
appflag string 合作方唯一标识
openid string 用户openid
book_count int 阅读作品数
ctg_count int 阅读作品二级分类数
read_duration int 阅读时长(秒)

请求示例：

https://cpapi-i.yuewen.com/wxhz/getreaddatabybook?appflag=xxx&timestamp=xxx&date_type=day&openid=xxx&start_time=xxx&end_time=xxx&page=1&sign=XXX

返回示例：

{
  "code": 0,
  "msg": "成功",
  "data": [
    {
      "statis_day": 20210428,
      "openid": "user",
      "book_count": 1,
      "ctg_count": 1,
      "read_duration": 1,
      "appflag": "test"
    }
  ]
}

# 特别说明

  1. 请求频率限制: 单个接口相同的入参每分钟仅允许请求一次
  2. 传入时间数据的逻辑为
    • 日、周、月皆为自然日(0-24点)、自然周（周一-周日）、自然月（1号-月底）。
    • 日周月数据表内主键分别为日期(YMD)、周一日期(YMD)、月份（YM），以21.8.10当天调用7.4-8.9的数据为例：
      • 日数据：7.4-8.9各天数据；
      • 周数据：7.5、7.12、7.19、7.26、8.2周数据；（7.4所在周的周一日期未在传参范围内，8.9所在周尚未结束，故不返回对应数据）
      • 月数据：7月数据。（8月因为未结束，不返回对应数据）

# 常见返回错误码code说明

code 说明
0 成功
1 通用失败
403 appflag错误，或业务配置问题
404 接口不存在
429 请求过于频繁，qps超过限制
500 系统内部错误，需咨询阅文对接人
1001 请求参数错误，具体看msg描述
1005 签名sign字段验签失败
1006 当前ip不在白名单，可登录阅文开放平台配置
1007 未授权的合作模式或合同过期等：联系阅文对接人配置
1009 timestamp字段与当前时间相差超过±300秒
1021 当前应用没有访问此api的权限：联系阅文对接人开通
10408 调用频率超限, 相同入参短时间内重复请求

← 文学分类ID和名称 →