小鹅通 · 云服务 API
首页
解决方案
  • 开放API
  • APP开店
文档中心应用市场控制台
首页
解决方案
  • 开放API
  • APP开店
文档中心应用市场控制台
  1. 场景方案
  • 开发前必读
    • 小鹅云介绍
    • 更新日志
    • 开始开发
    • 小鹅通开放API开发交流群
  • 开发指南
    • 创建并授权应用
    • 获取access_token(含代码示例)
    • 开通接口权限
    • 全局返回码
    • 常用工具
      • 日志排查工具
  • 场景方案
    • 同步用户场景
    • 同步商品场景
    • 同步订购关系场景
    • 同步积分场景
    • 同步页面统计场景
    • 同步学习数据场景
    • 同步推广员场景
  • 内嵌SDK服务场景
    • 产品简介
    • 小鹅通SDK开发者声明
    • 小鹅通SDK个人信息保护政策
    • 开发指南
    • Android-SDK 接入
    • iOS-SDK 接入
    • H5直接嵌入
    • SDK&H5账号详解
    • 常见问题
    • 原生SDK登录态
      • 先决条件
      • 登录接口
      • 登出接口
  • 消息推送
    • 使用说明
    • 消息加/解密
    • 消息接收URL校验说明
    • 账号合并推送
    • 用户手机号变更推送
    • 用户状态变更推送
    • 用户注册推送
    • 商品变更推送
    • 订单支付推送
    • 订单状态变更推送
    • 优惠券消息推送
    • 信息采集推送
    • 积分变更推送
    • 考试消息推送
    • 活动签到推送
  • API列表
    • 用户管理
      • 使用说明
      • 注册新用户
      • 更新用户信息
      • 获取用户列表2.0
      • 获取用户列表1.0.0
      • 查询单个用户信息
      • 批量查询获取用户信息
      • 获取用户消费信息
      • 获取课程学员列表
      • 查询单个用户标签列表
      • 查询用户合并记录
      • 获取标签列表
      • 添加/修改标签
      • 添加/修改用户标签
    • 学习数据管理
      • 获取学习记录列表
      • 获取每日学习记录
      • 获取指定资源学习记录信息
      • 获取营期下用户的学习情况
    • 直播管理
      • 获取直播列表
      • 获取班课列表接口
      • 获取签到列表
      • 获取签到学员列表
      • 获取直播红包列表
      • 获取红包领取记录
      • 获取直播数据概览
      • 获取直播详情
      • 获取红包数据概况
    • 商品管理
      • 查询商品列表2.0
      • 查询商品列表1.0
      • 拉取组合课的资源列表4.0
      • 拉取组合课的资源列表3.0
      • 获取训练营营期任务
      • 商品详情2.0
      • 商品详情1.0
      • 获取直播带货商品列表
      • 商品增加库存
      • 商品减少库存
      • 新建实物商品
      • 编辑实物商品
      • 删除实物商品
      • 获取实物商品列表
      • 获取C端搜索商品列表
    • 商品分组管理
      • 获取店铺商品分组列表
      • 获取商品分组内商品列表
      • 批量新建/更新商品分组
      • 删除商品分组
    • 素材管理
      • 获取素材列表
      • 获取素材分组列表
      • 素材分组编辑
      • 素材分组移动
      • 素材分组删除
    • 订单管理
      • 获取订单列表1.1
      • 获取订单列表1.0
      • 查询用户订单列表
      • 获取订单详情
    • 订购管理
      • 用户开通产品包权益
      • 查询用户订购资源列表
      • 用户购买关系查询
      • 查询用户资源权益2.0
      • 查询用户资源权益1.0
      • 取消订购
    • 物流管理
      • 普通实物单发货
    • 推广员管理
      • 查询推广员列表
      • 查询推广员客户列表
      • 查询推广员的下级推广员列表
      • 查询指定推广员的信息
      • 查询客户所属推广员
      • 新增推广员
      • 推广员绑定客户
      • 修改/解除绑定关系
      • 设置推广员上级
      • 推广订单详情
      • 按日期查询推广员的收益和新增加的下级
      • 推广订单详情(支持购物车订单返回多条记录)
    • 信息采集管理
      • 获取信息采集列表
      • 获取单个信息采集结果
      • 获取用户信息采集结果
      • 根据表单ID以及用户ID获取信息采集结果
    • 营销码卷管理
      • 优惠券列表
      • 获取优惠券详情2.0
      • 获取优惠券详情
      • 获取优惠券领券用户
      • 发放优惠券2.0
      • 发放优惠券
      • 优惠券核销
      • 获取优惠码列表
      • 获取优惠码码库列表
      • 获取优惠码效果数据
      • 创建优惠码
      • 优惠码添加库存
      • 优惠码失效
      • 编辑优惠码
      • 优惠码删除
      • 获取兑换码码库列表
      • 追加兑换码库存
      • 创建兑换码
      • 编辑兑换码
      • 兑换码失效
      • 用户使用兑换码
      • 获取兑换码批次列表
    • 积分管理
      • 业务类型说明
      • 查询用户积分日志
      • 获取单个用户积分信息
      • 批量获取用户积分列表
      • 获取店铺积分信息
      • 批量发放积分
      • 批量扣减积分
      • 解冻冻结积分
      • 设置店铺积分过期时间
    • 页面统计管理
      • 新建页面统计
      • 编辑页面统计
      • 获取页面统计列表
      • 获取页面统计详情
      • 获取页面统计订单列表
      • 新建投放渠道
      • 获取投放渠道列表
    • 打卡管理
      • 获取打卡列表
      • 获取打卡参与用户
      • 获取指定学员活动日记列表
      • 获取活动点赞列表
      • 获取指定学员被点赞总数和列表
      • 获取用户日记被点评/评论列表
    • 社群管理
      • 获取用户参与的小社群
    • 考试管理
      • 获取考试列表
      • 获取考试详情
      • 获取考试结果列表信息
      • 获取考试结果详细信息
    • 活动管理
      • 获取活动列表
      • 获取签到列表
      • 获取活动报名列表
      • 获取活动签到信息
    • 组织管理
      • 获取员工列表
      • 获取员工详细信息
      • 添加或者保存员工信息
      • 启用员工
      • 停用员工
      • 删除员工
      • 根据员工账号获取用户ID
      • 获取组织结构树
      • 添加或修改组织架构
      • 移除组织架构
    • 微页面管理
      • 获取微页面列表
    • 企学院专用
      • 学员管理
        • 企学院获取学员列表
        • 企学院添加学员
        • 企学院修改学员
        • 企学院删除学员
        • 企学院添加组织架构
        • 企学院删除组织架构
        • 企学院编辑组织架构
        • 企学院获取组织架构
        • 企学院获取部门信息
      • 活动管理
        • 企学院用户签到活动列表
      • 培训计划管理(限企学院)
        • 获取培训计划列表
        • 获取培训计划详情
        • 获取用户培训学习数据
        • 获取员工的培训计划列表
  • 旧版API
    • 使用须知
    • 旧版指南
      • 签名和请求
      • Xiaoe SDK使用简介
      • 状态码和常见问题
    • 用户
      • 用户注册
      • 用户信息修改
      • 获取用户信息
    • 支付
      • 下单
      • 更新订单状态
    • 订单
      • 订单查询1.0
      • 订单查询2.0
    • 订购
      • 订阅列表查询
      • 订阅用户列表查询
      • 取消订阅
  • 常见问题
    • 问题汇总
    • 问题反馈
  1. 场景方案

同步学习数据场景

背景#

商家想把用户在小鹅通的学习数据同步至自有系统中,用于对自有系统用户同步展示和对学员的学习行为数据进行自定义分析。 例如商家有自己的数据BI系统,通过获取学员学习数据,进行自定义的图表形式展示,方便运营人员跟进活跃用户。
备注:请在小鹅云-控制台申请商品、学习数据相关权限集

业务场景#

名词解释
名词解释
学习数据指每个用户针对每个学习资源的学习时长、学习进度等数据
单课指图文、音频、视频、直播、电子书等单独的课程类型
专栏包括专栏与大专栏课程类型
业务场景 img

场景一:获取用户所有课程学习数据#

获取指定用户在小鹅云店铺内所有课程的学习记录数据,方便商家可在自有系统上针对活跃用户开展运营活动

流程说明#

需先调用获取用户列表接口,获取店铺内对应的用户id数据;
根据对应用户id数据,调用获取学习记录列表接口,来查询该用户在店铺内的学习情况。

调用接口流程#

img

涉及接口汇总#

接口接口描述
xe.user.batch.get/1.0.0获取用户列表
xe.user.learning.records.get/1.0.0获取学习记录列表

场景二:获取用户每日学习数据#

能够通过选择相应的日期,获取该日期内用户学习过的每个学习资源的学习数据,商家可跟进用户每日学习行为情况

流程说明#

可先调用获取用户列表接口,获取店铺内对应的用户id数据;
选择对应日期,调用获取每日学习数据接口,来查询该日期内用户的课程学习情况。

调用接口流程#

img

涉及接口汇总#

接口接口描述
xe.user.batch.get/1.0.0获取用户列表
xe.learning_records.daily.get/1.0.0获取学习记录列表

场景三:获取单课的学习数据#

获取图文、音频、视频、直播、电子书等课程类型的指定课程学习情况,商家可针对指定课程进行自定义数据统计分析,了解课程下的用户学习情况

流程说明#

需先调用查询商品列表接口,获取店铺内商品课程id数据;
根据对应单课课程id数据,调用获取指定资源学习记录信息接口,来查询该课程的用户学习情况。

调用接口流程#

img

涉及接口汇总#

接口接口描述
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数据,调用获取指定资源学习记录信息接口,来查询该专栏下的课程的用户学习情况。

调用接口流程#

img

涉及接口汇总#

接口接口描述
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,调用获取营期下用户的学习情况,获取训练营下的用户的学习数据。

调用接口流程#

img

涉及接口汇总#

接口接口描述
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获取营期下用户的学习情况
上一页
同步页面统计场景
下一页
同步推广员场景
Built with