同步学习数据场景
背景
商家想把用户在小鹅通的学习数据同步至自有系统中，用于对自有系统用户同步展示和对学员的学习行为数据进行自定义分析。 例如商家有自己的数据BI系统，通过获取学员学习数据，进行自定义的图表形式展示，方便运营人员跟进活跃用户。
备注：请在小鹅云-控制台申请商品、学习数据相关权限集
业务场景
名词解释
| 名词 | 解释 |
|---|---|
| 学习数据 | 指每个用户针对每个学习资源的学习时长、学习进度等数据 |
| 单课 | 指图文、音频、视频、直播、电子书等单独的课程类型 |
| 专栏 | 包括专栏与大专栏课程类型 |
业务场景
场景一：获取用户所有课程学习数据
获取指定用户在小鹅云店铺内所有课程的学习记录数据，方便商家可在自有系统上针对活跃用户开展运营活动
流程说明
- 需先调用获取用户列表接口，获取店铺内对应的用户id数据；
- 根据对应用户id数据，调用获取学习记录列表接口，来查询该用户在店铺内的学习情况。
调用接口流程
涉及接口汇总
| 接口 | 接口描述 |
|---|---|
| xe.user.batch.get/1.0.0 | 获取用户列表 |
| xe.user.learning.records.get/1.0.0 | 获取学习记录列表 |
场景二：获取用户每日学习数据
能够通过选择相应的日期，获取该日期内用户学习过的每个学习资源的学习数据，商家可跟进用户每日学习行为情况
流程说明
- 可先调用获取用户列表接口，获取店铺内对应的用户id数据；
- 选择对应日期，调用获取每日学习数据接口，来查询该日期内用户的课程学习情况。
调用接口流程
涉及接口汇总
| 接口 | 接口描述 |
|---|---|
| xe.user.batch.get/1.0.0 | 获取用户列表 |
| xe.learning_records.daily.get/1.0.0 | 获取学习记录列表 |
场景三：获取单课的学习数据
获取图文、音频、视频、直播、电子书等课程类型的指定课程学习情况，商家可针对指定课程进行自定义数据统计分析，了解课程下的用户学习情况
流程说明
- 需先调用查询商品列表接口，获取店铺内商品课程id数据；
- 根据对应单课课程id数据，调用获取指定资源学习记录信息接口，来查询该课程的用户学习情况。
调用接口流程
涉及接口汇总
| 接口 | 接口描述 |
|---|---|
| api/xe.goods.list.get/3.0.0 | 查询商品列表 |
| xe.user.leaning_record_by_resource.get/1.0.0 | 获取指定资源学习记录信息 |
场景四：获取专栏的学习数据
获取专栏、大专栏等课程类型的指定课程学习情况，商家可获取到专栏内具体课程的用户学习情况，并在自有系统中进行自定义数据统计分析
流程说明
- 需先调用查询商品列表接口，获取店铺内专栏id数据；
- 根据对应专栏id数据，调用查询组合课资源列表4.0.0接口，获取专栏内课程id数据；
- 通过专栏内课程id数据，调用获取指定资源学习记录信息接口，来查询该专栏下的课程的用户学习情况。
调用接口流程
涉及接口汇总
| 接口 | 接口描述 |
|---|---|
| api/xe.goods.list.get/3.0.0 | 查询商品列表 |
| xe.goods.relation.get/4.0.0 | 查询组合课资源列表4.0.0 |
| xe.user.leaning_record_by_resource.get/1.0.0 | 获取指定资源学习记录信息 |
场景五：获取用户每日学习数据
获取指定训练营的用户训练营课程学习情况，可获取到训练营营期下的用户整体学习进度，商家可将数据同步至自有系统中，针对完成训练营任务用户开展运营活动
流程说明
- 需先调用查询商品列表接口，获取训练营资源id；
- 通过训练营资源id，调用查询组合课资源列表4.0.0接口，获得训练营营期id；
- 通过训练营营期id，调用获取营期下用户的学习情况，获取训练营下的用户的学习数据。
调用接口流程
涉及接口汇总
| 接口 | 接口描述 |
|---|---|
| api/xe.goods.list.get/3.0.0 | 查询商品列表 |
| xe.goods.relation.get/4.0.0 | 查询组合课资源列表4.0.0 |
| xe.camp.user_progress/1.0.0 | 获取营期下用户的学习情况 |