获取指定资源学习记录信息
| 拥有此API的权限集 |
|---|
| 学习数据-查询 |
请求方式及url
- 请求方式：
POST - 请求头：
Content-Type:application/json - 接口地址：
https://api.xiaoe-tech.com/xe.user.leaning_record_by_resource.get/1.0.0 - 频率限制：
10秒3000次 备注：
数据是准实时的，4~5分钟延迟学习时长类指标受设备限制不包含以下播放场景：息屏播放、后台播放、投屏播放、悬浮窗播放
在线调试工具
请求
响应
请求参数
| 参数名 | 必选 | 类型 | 说明 | 备注（示例） |
|---|---|---|---|---|
| access_token | 是 | string | 专属token | ... |
| resource_id | 是 | string | 资源id | ... |
| data.list | 是 | array | user_id数组 | 上限100, 如果传空数组，则代表所有用户 |
| data.max_record | 否 | bool | 是否获取学习最大记录，默认false，设为true后会在所有终端的学习记录中获取最大学习记录的一条记录 | ... |
| data.is_search | 否 | bool | 是否启用搜索，默认false | ... |
| data.search_max_learn_progress | 否 | int | 最小完成百分比，添加后会筛选出来max_learn_progress > {指定值}的学习记录，值：0-100 | ... |
| data.stay_time | 否 | int | 该资源的看课学习时长，添加后会筛选出来stay_time >= {指定值}的学习记录 | ... |
| page | 是 | int | 页数 | ... |
| page_size | 是 | int | 页码（最大数为100） | ... |
请求示例
{
"access_token" : "xxxxxxxx",
"resource_id" : "xxxxxx",
"data" : {
"search_max_learn_progress" : 90,
"list" : [
"xxxx"
]
},
"page": 1,
"page_size": 10
}
返回参数
| 参数名 | 类型 | 说明 | 备注（示例） |
|---|---|---|---|
| code | int | 错误码 | 0 |
| msg | string | 错误描述 | ok |
| data | Object | 返回值 | ... |
| data.page | int | 页数 | ... |
| data.page_size | int | 页码（最大数为100） | ... |
| data.total | int | 总数 | ... |
| data.list | 数组 | 学习记录列表 | ... |
list说明
| 参数名 | 类型 | 说明 | 备注（示例） |
|---|---|---|---|
| id | int | id | |
| user_id | string | 用户user_id | ... |
| shop_id | string | 店铺id | ... |
| resource_id | int | 内容的id | i_xxxx |
| resource_type | int | 内容的类型 | 图文-1，音频-2，视频-3，直播-4，电子书-20 |
| learn_progress | int | 最近一次学习进度 0-100 | 40 |
| org_learn_progress | string | 原始学习进度：图文阅读位置的高度（单位px），音视频为播放时间（单位s），直播可为空 （也可以自定义）,当考试时，表示分数 | 900 |
| is_finish | int | 是否已学完 1-已学完 | 1 |
| finished_at | string | 完成时间 | 2018-10-21 12:00:00 |
| max_learn_progress | int | 最大学习进度 | 100 |
| state | int | 标识删除状态 0未删除 1已删除 | 0 |
| updated_at | string | 更新时间 | 2021-03-22 12:00:000 |
| created_at | string | 创建时间 | 2021-03-22 12:00:00 |
| last_learn_time | string | 最近一次学习时间 | 2018-10-21 12:00:00 |
| stay_time | int | 学习时长 | 单位：秒 |
返回示例
{
"code":0,
"msg":"ok",
"data":{
"page":1,
"page_size":1,
"total":3,
"list":[
{
"max_learn_progress":35,
"stay_time":2648,
"state":0,
"agent_type":1,
"id":0,
"shop_id":"appxxx",
"resource_type":4,
"org_learn_progress":"",
"resource_id":"l_xxx",
"is_finish":0,
"updated_at":"2021-11-22 00:08:17",
"created_at":"2021-11-21 23:24:07",
"user_id":"u_xxx",
"learn_progress":35,
"finished_at":"0001-01-01 00:00:00",
"last_learn_time":"2021-11-22 00:08:17"
}
]
}
}