# 数据统计相关API

注意事项

所有API接口的域名前缀：http://gateway--cnki--net--https.cnki.mdjsf.utuvpn.utuedu.com:9000/openx/

所有接口统一认证方式：Header请求头中添加Authorization字段，值为"Bearer " +JWT

Authorization值获取方式，参见：JWT相关接口API | 知网研学开放平台文档 (cnki.net) (opens new window)

appId等应用信息获取方式参见：快速入门 | 知网研学开放平台文档 (cnki.net) (opens new window)

# 数据统计 -按日期查询机构数据列表

接口地址 /inst/day/v1/stat

请求方式 POST

请求数据类型:application/json

接口描述 根据机构id、用户名获取指定用户在指定日期范围内的使用数据

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型
startTime	开始日期（格式"2022-07-11"）	query	true	String
endTime	结束日期（格式"2022-07-11"）	query	true	String
userName	用户名	query	false	String
limit	每页最大条数，不超过100，超出100只返回100条，不传默认100条	query	false	int
page	页码，默认1	query	false	int
sort	排序，1代表正序，0代表倒叙	query	false	int
teamId	机构id	query	true	String

响应状态

状态码	说明
200	OK
416001	服务异常
416002	错误的access_token
416011	无效的参数
416012	无效的日期
416013	Jwt校验失败
416014	Jwt过期

响应参数

参数名称	参数说明	类型	schema属性
code	错误码	string
message	说明	string
content	内容	object	DataObject
success	是否请求成功	boolean
count	数据条数	Integer
total	总条数	Integer

schema属性说明

DataObject

参数名称	参数说明	类型	schema
pageNum	页码	int
pageSize	每页条数	int
totalPage	总页数	int
total	总条数	int
list	数据列表	Array	OrgData

返回值OrgData

参数名称	参数说明	类型
id	主键	int
dt	日期	string
userName	用户名称	string
centoCt	摘录量	int
noteCt	笔记量	int
collectCt	文献收藏量	int
subjectCt	专题创建量	int
createCt	创作量	int
packGetCt	资源包获取量	int
readCt	阅读量	int
readFt	阅读文献篇数	int
matrixCt	矩阵量	int
uploadCt	文献上传量	int
assemblyCt	笔记汇编量	int
subscribeCt	订阅量	int

响应示例

{
    "success": true,
    "message": "SUCCESS",
    "content": {
        "pageNum": 1,
        "pageSize": 10,
        "totalPage": 1,
        "total": 1,
        "list": [
            {
                "id": 1,
                "dt": "2015-01-02",
                "teamId": "deb27066****14dda97f185c",
                "userId": "df9bffaf****6e9452fbd1b1",
                "userName": "138****9782",
                "centoCt": 0,
                "noteCt": 4,
                "collectCt": 0,
                "subjectCt": 0,
                "createCt": 0,
                "packGetCt": 0,
                "centoAlbum": null,
                "centoAlbumCt": 0,
                "centoMaxFile": null,
                "noteAlbum": null,
                "noteAlbumCt": 0,
                "noteMaxFile": null,
                "collectAlbum": null,
                "collectAlbumCt": 0,
                "readCt": 4,
                "readFt": 0,
                "readAlbum": null,
                "readAlbumCt": 0,
                "readMaxFile": null,
                "matrixCt": 0,
                "uploadCt": 1,
                "assemblyCt": 0,
                "subscribeCt": 0
            }
        ]
    },
    "count": null,
    "total": null,
    "code": 200
}

# 数据统计 -按周查询机构数据列表

接口地址 /inst/week/v1/stat

请求方式 POST

请求数据类型:application/json

接口描述 根据机构id、用户名获取指定用户在指定周范围内的使用数据

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型
startTime	开始周（时间格式“年份@第几周”，例"2022@22"）	query	true	String
endTime	结束周（时间格式“年份@第几周”，例"2022@22"）	query	true	String
userName	用户名	query	false	String
limit	每页最大条数，不超过100，超出100只返回100条，不传默认100条	query	false	int
page	页码，默认1	query	false	int
sort	排序，1代表正序，0代表倒叙	query	false	int
teamId	机构id	query	true	String

响应状态

状态码	说明
200	OK
416001	服务异常
416002	错误的access_token
416011	无效的参数
416012	无效的日期
416013	Jwt校验失败
416014	Jwt过期

响应参数

参数名称	参数说明	类型	schema属性
code	错误码	string
message	说明	string
data	内容	object	DataObject
success	是否请求成功	boolean
count	数据条数	Integer
total	总条数	Integer

schema属性说明

DataObject

参数名称	参数说明	类型	schema
pageNum	页码	int
pageSize	每页条数	int
totalPage	总页数	int
total	总条数	int
list	数据列表	Array	OrgData

OrgData

参数名称	参数说明	类型
id	主键	int
wt	周	string
userName	用户名称	string
centoCt	摘录量	int
noteCt	笔记量	int
collectCt	文献收藏量	int
subjectCt	专题创建量	int
createCt	创作量	int
packGetCt	资源包获取量	int
readCt	阅读量	int
readFt	阅读文献篇数	int
matrixCt	矩阵量	int
uploadCt	文献上传量	int
assemblyCt	笔记汇编量	int
subscribeCt	订阅量	int

响应示例

{
    "success": true,
    "message": "SUCCESS",
    "content": {
        "pageNum": 1,
        "pageSize": 10,
        "totalPage": 1,
        "total": 1,
        "list": [
            {
                "id": 27,
                "wt": "2015@01",
                "userName": "138****9782",
                "centoCt": 0,
                "noteCt": 6,
                "collectCt": 0,
                "subjectCt": 0,
                "createCt": 0,
                "packGetCt": 0,
                "readCt": 6,
                "readFt": 0,
                "matrixCt": 0,
                "uploadCt": 1,
                "assemblyCt": 0,
                "subscribeCt": 0
            }
        ]
    },
    "count": null,
    "total": null,
    "code": 200
}

# 数据统计 -按月查询机构数据列表

接口地址 /inst/month/v1/stat

请求方式 POST

请求数据类型:application/json

接口描述 根据机构id、用户名获取指定用户在指定月范围内的使用数据

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型
startTime	开始时间（时间格式“年份@第几月”，例"2022@03"）	query	true	String
endTime	开始时间（时间格式“年份@第几月”，例"2022@03"）	query	true	String
userName	用户名	query	false	String
limit	每页最大条数，不超过100，超出100只返回100条，不传默认100条	query	false	int
page	页码，默认1	query	false	int
sort	排序，1代表正序，0代表倒叙	query	false	int
teamId	机构id	query	true	String

响应状态

状态码	说明
200	OK
416001	服务异常
416002	错误的access_token
416011	无效的参数
416012	无效的日期
416013	Jwt校验失败
416014	Jwt过期

响应参数

参数名称	参数说明	类型	schema属性
code	错误码	string
message	说明	string
data	内容	object	DataObject
success	是否请求成功	boolean
count	数据条数	Integer
total	总条数	Integer

schema属性说明

DataObject

参数名称	参数说明	类型	schema
pageNum	页码	int
pageSize	每页条数	int
totalPage	总页数	int
total	总条数	int
list	数据列表	Array	OrgData

OrgData

参数名称	参数说明	类型
id	主键	int
mt	月	string
userName	用户名称	string
centoCt	摘录量	int
noteCt	笔记量	int
collectCt	文献收藏量	int
subjectCt	专题创建量	int
createCt	创作量	int
packGetCt	资源包获取量	int
readCt	阅读量	int
readFt	阅读文献篇数	int
matrixCt	矩阵量	int
uploadCt	文献上传量	int
assemblyCt	笔记汇编量	int
subscribeCt	订阅量	int

响应示例

{
    "success": true,
    "message": "SUCCESS",
    "content": {
        "pageNum": 1,
        "pageSize": 10,
        "totalPage": 1,
        "total": 1,
        "list": [
            {
                "id": 26,
                "mt": "2015-01",
                "userName": "138****9782",
                "centoCt": 0,
                "noteCt": 6,
                "collectCt": 0,
                "subjectCt": 0,
                "createCt": 0,
                "packGetCt": 0,
                "readCt": 6,
                "readFt": 0,
                "matrixCt": 0,
                "uploadCt": 1,
                "assemblyCt": 0,
                "subscribeCt": 0
            }
        ]
    },
    "count": null,
    "total": null,
    "code": 200
}

# 数据统计 -按年查询机构数据列表

接口地址 /inst/year/v1/stat

请求方式 POST

请求数据类型:application/json

接口描述 根据机构id、用户名获取指定用户在指定年范围内的使用数据

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型
startTime	开始时间（时间格式“年份@第几月”，例"2022"）	query	true	String
endTime	开始时间（时间格式“年份@第几月”，例"2023"）	query	true	String
userName	用户名	query	false	String
limit	每页最大条数，不超过100，超出100只返回100条，不传默认100条	query	false	int
page	页码，默认1	query	false	int
sort	排序，1代表正序，0代表倒叙	query	false	int
teamId	机构id	query	true	String

响应状态

状态码	说明
200	OK
416001	服务异常
416002	错误的access_token
416011	无效的参数
416012	无效的日期
416013	Jwt校验失败
416014	Jwt过期

响应参数

参数名称	参数说明	类型	schema属性
code	错误码	string
message	说明	string
data	内容	object	DataObject
success	是否请求成功	boolean
count	数据条数	Integer
total	总条数	Integer

schema属性说明

DataObject

参数名称	参数说明	类型	schema
pageNum	页码	int
pageSize	每页条数	int
totalPage	总页数	int
total	总条数	int
list	数据列表	Array	OrgData

OrgData

参数名称	参数说明	类型
id	主键	int
yt	年	string
userName	用户名称	string
centoCt	摘录量	int
noteCt	笔记量	int
collectCt	文献收藏量	int
subjectCt	专题创建量	int
createCt	创作量	int
packGetCt	资源包获取量	int
readCt	阅读量	int
readFt	阅读文献篇数	int
matrixCt	矩阵量	int
uploadCt	文献上传量	int
assemblyCt	笔记汇编量	int
subscribeCt	订阅量	int

响应示例

{
    "success": true,
    "message": "SUCCESS",
    "content": {
        "pageNum": 1,
        "pageSize": 10,
        "totalPage": 1,
        "total": 1,
        "list": [
            {
                "id": 73,
                "yt": "2015",
                "userName": "138****9782",
                "centoCt": 0,
                "noteCt": 6,
                "collectCt": 0,
                "subjectCt": 0,
                "createCt": 0,
                "packGetCt": 0,
                "readCt": 6,
                "readFt": 0,
                "matrixCt": 0,
                "uploadCt": 1,
                "assemblyCt": 0,
                "subscribeCt": 0
            }
        ]
    },
    "count": null,
    "total": null,
    "code": 200
}

# 数据统计 -查询指定用户指定日期期间的阅读篇数

接口地址 /doc/fileDay/query

请求方式 POST

请求数据类型:application/json

接口描述 根据用户id和日期范围查询用户在指定日期范围内每天的阅读篇数

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型
startTime	开始时间（时间格式“年份@第几月”，例"2022"）	query	true	String
endTime	开始时间（时间格式“年份@第几月”，例"2023"）	query	true	String
userId	用户标识	query	true	String
pageNum	页码	query	false	int
pageSize	每页条数	query	false	int

响应状态

状态码	说明
200	OK
416001	服务异常
416002	错误的access_token
416011	无效的参数
416012	无效的日期
416013	Jwt校验失败
416014	Jwt过期

响应参数

参数名称	参数说明	类型	schema属性
code	错误码	string
message	说明	string
success	成功返回true，失败返回false	boolean
content	返回正文	List<AdsUserViewDVo>	AdsUserViewDVo
count	数据条数	integer
total	总条数	integer

schema属性说明

AdsUserViewDVo

参数名称	参数说明	类型
dt	日期	string
userId	用户id	string
totalReadFt	总阅读篇数	int

响应示例

{
  "code": 0,
  "message": null,
  "success": true,
  "content": [
      {
        "dt": "2024-01-01",
        "userId": "asdadsd",
        "totalReadFt": 10
      },
      {
        "dt": "2024-01-02",
        "userId": "asdadsd",
        "totalReadFt": 13
      }
    ],
    "count":null,
    "total":null
}

← 三方平台获取临时登录授权码积分服务 →