Skip to content

获取学习记录列表

拥有此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_tokenstring专属token...
user_idstring用户id...
data.pageint页码从1开始
data.page_sizeint页容量默认10,最大50
data.agent_typeint数据来源默认1-pc/h5端,10-SDK

请求示例

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

返回参数

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

列表goods_list

参数名必选类型说明备注(示例)
idstring自增主键...
resource_idstring内容的idi_xxx
resource_typeint内容的类型图文-1,音频-2,视频-3,直播-4,电子书-20
learn_progressint最近一次学习进度 0-100(当前停留进度)40
org_learn_progressstring原始学习进度:图文阅读位置的高度(单位px),音视频为播放时间(单位s),直播可为空 (也可以自定义)900
is_finishint是否已学完 1-已学完1
finished_atstring首次完成时间2018-10-21 12:00:00
agent_typeint终端来源(1-h5,2-app,4-小程序)1
max_learn_progressint历史最大学习进度(不一定是当前停留进度)100
created_atstring首次学习时间...
app_idstring店铺app_id...
product_idstring上级资源id...
last_learn_timestring最近一次学习时间,默认按该字段倒序排序2018-10-21 12:00:00
stay_timeint停留时长(学习时长),单位:秒30
content_app_idstring内容方店铺ID30
infoObject内容的基本数据废弃,不可用

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

参数名必选类型说明备注(示例)
goods_idstring内容的idi_xxxx
goods_typeint内容的类型图文-1,音频-2,视频-3,直播-4,电子书-20
titlestring资源标题标题
resource_typeint内容的类型图文-1,音频-2,视频-3,直播-4,电子书-20
authorstring作者一分钟了解小鹅通(体验内容)
img_urlstring封面原图http://xxxx
img_url_compressedstring封面压缩小图http://xxxx
img_url_compressed_largerstring封面压缩大图http://xxxx
priceint商品价格 单位:分1
line_priceint划线价格(单位:分)1
alive_start_atstring直播开始时间2018-10-1 10:00:00
alive_stop_atstring直播结束时间2018-10-21 12:00:00
alive_statusint直播状态0-未开始 1-正在直播 2-已结束
sale_statusint上下架状态 0-上架 1-下架0
update_statusint更新状态 0-更新中 1-已完结1
is_stop_sellint是否停止售卖0
is_ineffectiveint是否无效 1-是 0-否0
has_buyint是否购买资源 1-是 0-否0
stateint资源状态 0-正常 1-隐藏 2-删除0
is_tryint是否试用 1-试用 0-非试用0
periodical_countint更新期数0
org_summarystring会员的简介简介
is_expireint会员是否过期1-过期
marketing_infoobject营销活动信息null
distribution_resource_idstring分销商品idxx
sale_numint售卖数量0
stockint库存0
is_lookbackint是否直播回放 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
    }
}