获取学习记录列表

拥有此API的权限集
学习数据-查询

请求方式及url

  • 请求方式:POST
  • 请求头:Content-Type:application/json
  • 接口地址:https://api.xiaoe-tech.com/xe.user.learning.records.get/1.0.0
  • 频率限制:10秒1000次
  • 备注:

    数据是准实时的,4~5分钟延迟

    学习时长类指标受设备限制不包含以下播放场景:息屏播放、后台播放、投屏播放、悬浮窗播放

在线调试工具

请求

响应

请求参数

参数名 必选 类型 说明 备注(示例)
access_token string 专属token ...
user_id string 用户id ...
data.page int 页码 从1开始
data.page_size int 页容量 默认10,最大50
data.agent_type int 数据来源 默认1-pc/h5端,10-SDK

请求示例

{
    "access_token": "xxxxxxxx",
    "user_id": "u_xxxx",
    "data": {
        "page": 1,
        "page_size": 10
    }
}

返回参数

参数名 必选 类型 说明 备注(示例)
code int 错误码 0
msg string 错误描述 ok
data Object 返回值 ...
data.goods_list 数组 收藏列表 ...

列表goods_list

参数名 必选 类型 说明 备注(示例)
id string 自增主键 ...
resource_id string 内容的id i_xxx
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
agent_type int 终端来源(1-h5,2-app,4-小程序) 1
max_learn_progress int 历史最大学习进度(不一定是当前停留进度) 100
created_at string 首次学习时间 ...
app_id string 店铺app_id ...
product_id string 上级资源id ...
last_learn_time string 最近一次学习时间,默认按该字段倒序排序 2018-10-21 12:00:00
stay_time int 停留时长(学习时长),单位:秒 30
content_app_id string 内容方店铺ID 30
info Object 内容的基本数据 废弃,不可用

info内容的基本数据,现已废弃

参数名 必选 类型 说明 备注(示例)
goods_id string 内容的id i_xxxx
goods_type int 内容的类型 图文-1,音频-2,视频-3,直播-4,电子书-20
title string 资源标题 标题
resource_type int 内容的类型 图文-1,音频-2,视频-3,直播-4,电子书-20
author string 作者 一分钟了解小鹅通(体验内容)
img_url string 封面原图 http://xxxx
img_url_compressed string 封面压缩小图 http://xxxx
img_url_compressed_larger string 封面压缩大图 http://xxxx
price int 商品价格 单位:分 1
line_price int 划线价格(单位:分) 1
alive_start_at string 直播开始时间 2018-10-1 10:00:00
alive_stop_at string 直播结束时间 2018-10-21 12:00:00
alive_status int 直播状态 0-未开始 1-正在直播 2-已结束
sale_status int 上下架状态 0-上架 1-下架 0
update_status int 更新状态 0-更新中 1-已完结 1
is_stop_sell int 是否停止售卖 0
is_ineffective int 是否无效 1-是 0-否 0
has_buy int 是否购买资源 1-是 0-否 0
state int 资源状态 0-正常 1-隐藏 2-删除 0
is_try int 是否试用 1-试用 0-非试用 0
periodical_count int 更新期数 0
org_summary string 会员的简介 简介
is_expire int 会员是否过期 1-过期
marketing_info object 营销活动信息 null
distribution_resource_id string 分销商品id xx
sale_num int 售卖数量 0
stock int 库存 0
is_lookback int 是否直播回放 1-是 0-否 0

返回示例

{
    "code": 0,
    "msg": "ok",
    "data": {
        "goods_list": [
            {
                "id": 0,
                "resource_id": "i_x",
                "resource_type": 1,
                "learn_progress": 100,
                "org_learn_progress": "",
                "is_finish": 1,
                "finished_at": "2021-07-30 13:29:05",
                "stay_time": 130,
                "last_learn_time": "2021-07-30 13:29:05",
                "info": {
                    "goods_id": "i_x",
                    "goods_type": 1,
                    "title": "cw1", 
                    "author": "",
                    "img_url": "http://x.gif",
                    "img_url_compressed": "http://x.gif",
                    "img_url_compressed_larger": "http://x.gif",
                    "price": 150,
                    "line_price": 300,
                    "alive_start_at": "",
                    "alive_stop_at": "",
                    "alive_status": 0,
                    "sale_status": 0,
                    "state": 0,
                    "update_status": 0,
                    "is_stop_sell": 0,
                    "is_ineffective": 0,
                    "has_buy": 0,
                    "is_try": 0,
                    "periodical_count": 0,
                    "org_summary": "",
                    "is_expire": 0,
                    "marketing_info": null,
                    "distribution_resource_id": "",
                    "sale_num": 0,    
                    "stock": 0,    
                    "is_lookback": 0    
                },
                "content_app_id": "",
                "agent_type": 1,            
                "max_learn_progress": 100,    
                "created_at": "2021-07-30 13:27:05",    
                "app_id": "appxxx",    
                "product_id": ""    
            }
        ],
        "total": 17
    }
}

results matching ""

    No results matching ""