获取视频自定义参数播放记录日志
更新时间:2020-09-30
1. v3版本
接口描述
该接口用于获取视频自定义参数播放记录日志,v3接口在v2基础上,终端细化到Flash、H5-PC、Android、iOS、H5-移动等。
请求地址
https://spark.bokecc.com/api/playlog/custom/video/v3
请求方式
GET
请求参数
以下请求参数需要进行THQS权限认证, 权限认证方式请参考THQS认证方式。
名称 |
类型 |
必填 |
描述 |
userid |
String |
是 |
用户ID。 |
videoid |
String |
是 |
视频ID。 |
customid |
String |
是 |
自定义ID,最大长度为100。 |
date |
String |
是 |
查询日期,日期不能大于今日,格式:yyyy-MM-dd。 |
num_per_page |
Integer |
否 |
分页参数,每页显示数量,默认为5000。取值范围:1~5000之间的任意整数。 |
page |
Integer |
否 |
分页参数,页码,默认为1。取值范围:大于0的整数。 |
请求示例
https://spark.bokecc.com/api/playlog/custom/video/v3?date=2017-07-06&videoid=6D080640AF53B5D363835A29B2A11xxx&page=1&time=1671629598240&customid=record1&userid=CC443A6686737xxx&hash=A72CEEB521C554B43C4C2ACBF91D29C2&num_per_page=100
返回数据
名称 |
类型 |
说明 |
play_logs |
Object |
播放日志。 |
play_logs说明
名称 |
类型 |
说明 |
total |
Integer |
返回日志条数。 |
play_log |
Array |
播放日志信息。 |
play_log说明
名称 |
类型 |
说明 |
upid |
Integer |
每次播放时产生的随机数字。 |
userid |
String |
用户ID。 |
videoid |
String |
视频ID。 |
custom_id |
String |
自定义ID。 |
play_duration |
Integer |
播放时长。 |
play_position |
Integer |
最后播放位置。 |
video_duration |
Integer |
视频时长。 |
ip |
String |
IP地址。 |
province |
String |
省份名称。 |
city |
String |
城市名称。 |
referer |
String |
来源域名。 |
device |
String |
设备类型。 |
operating_system |
String |
操作系统。 |
browser |
String |
浏览器类型。 |
terminal |
String |
终端类型。 |
start_time |
String |
开始播放时间。 |
end_time |
String |
结束播放时间。 |
返回示例
{
"play_logs": {
"total": 1000,
"play_log": [
{
"upid": 4874841499354241000,
"userid": "CC443A6686737xxx",
"videoid": "6D080640AF53B5D363835A29B2A11xxx",
"custom_id": "record1",
"play_duration": 20000,
"play_position": 9622,
"video_duration": 262686,
"ip": "202.189.0.2",
"province": "北京市",
"city": "北京市",
"referer": "www.bokecc.com",
"device": "PC",
"operating_system": "WIN7",
"browser": "IE 11",
"terminal": "PC",
"start_time": "2017-07-06 23:17:29",
"end_time": "2017-07-06 23:17:49"
},
......
]
}
}
2. v2版本
接口描述
该接口用于获取视频自定义参数播放记录日志,v2在v1基础上增加分页查询功能。
请求地址
https://spark.bokecc.com/api/playlog/custom/video/v2
请求方式
GET
请求参数
以下请求参数需要进行THQS权限认证, 权限认证方式请参考THQS认证方式。
名称 |
类型 |
必填 |
描述 |
userid |
String |
是 |
用户ID。 |
videoid |
String |
是 |
视频ID, |
customid |
String |
是 |
自定义ID,最大长度为100。 |
date |
String |
是 |
查询日期,日期不能大于今日,格式:yyyy-MM-dd。 |
num_per_page |
Integer |
否 |
分页参数,每页显示数量,默认为5000。取值范围:1~5000之间的任意整数。 |
page |
Integer |
否 |
分页参数,页码,默认为1。取值范围:大于0的整数。 |
请求示例
https://spark.bokecc.com/api/playlog/custom/video/v2?date=2017-07-06&videoid=6D080640AF53B5D363835A29B2A11xxx&page=1&time=1671629598240&customid=record1&userid=CC443A6686737xxx&hash=A72CEEB521C554B43C4C2ACBF91D29C2&num_per_page=100
返回数据
名称 |
类型 |
说明 |
play_logs |
Object |
播放日志。 |
play_logs说明
名称 |
类型 |
说明 |
total |
Integer |
返回日志条数。 |
play_log |
Array |
播放日志信息。 |
play_log说明
名称 |
类型 |
说明 |
upid |
Integer |
每次播放时产生的随机数字。 |
userid |
String |
用户ID。 |
videoid |
String |
视频ID。 |
custom_id |
String |
自定义ID。 |
play_duration |
Integer |
播放时长。 |
play_position |
Integer |
最后播放位置。 |
video_duration |
Integer |
视频时长。 |
ip |
String |
IP地址。 |
province |
String |
省份名称。 |
city |
String |
城市名称。 |
referer |
String |
来源域名。 |
device |
String |
设备类型。 |
operating_system |
String |
操作系统。 |
browser |
String |
浏览器类型。 |
terminal |
String |
终端类型。 |
start_time |
String |
开始播放时间。 |
end_time |
String |
结束播放时间。 |
返回示例
{
"play_logs": {
"total": 1000,
"play_log": [
{
"upid": 4874841499354241000,
"userid": "CC443A6686737xxx",
"videoid": "6D080640AF53B5D363835A29B2A11xxx",
"custom_id": "record1",
"play_duration": 20000,
"play_position": 9622,
"video_duration": 262686,
"ip": "202.189.0.2",
"province": "北京市",
"city": "北京市",
"referer": "www.bokecc.com",
"device": "PC",
"operating_system": "WIN7",
"browser": "IE 11",
"terminal": "PC",
"start_time": "2017-07-06 23:17:29",
"end_time": "2017-07-06 23:17:49"
},
......
]
}
}
3. v1版本
接口描述
该接口用于获取视频自定义参数播放记录日志。
请求地址
https://spark.bokecc.com/api/playlog/custom/video
请求方式
GET
请求参数
以下请求参数需要进行THQS权限认证, 权限认证方式请参考THQS认证方式。
名称 |
类型 |
必填 |
描述 |
userid |
String |
是 |
用户ID。 |
videoid |
String |
是 |
视频ID。 |
customid |
String |
是 |
自定义ID,最大长度为100。 |
date |
String |
是 |
查询日期,日期不能大于今日,格式:yyyy-MM-dd。 |
请求示例
https://spark.bokecc.com/api/playlog/custom/video?date=2017-07-06&videoid=6D080640AF53B5D363835A29B2A11xxx&time=1671629598240&customid=record1&userid=CC443A6686737xxx&hash=A72CEEB521C554B43C4C2ACBF91D29C2
返回数据
名称 |
类型 |
说明 |
play_logs |
Object |
播放日志。 |
play_logs说明
名称 |
类型 |
说明 |
play_log |
Array |
播放日志信息。 |
play_log说明
名称 |
类型 |
说明 |
upid |
Integer |
每次播放时产生的随机数字。 |
userid |
String |
用户ID。 |
videoid |
String |
视频ID。 |
custom_id |
String |
自定义ID。 |
play_duration |
Integer |
播放时长。 |
play_position |
Integer |
最后播放位置。 |
video_duration |
Integer |
视频时长。 |
ip |
String |
IP地址。 |
province |
String |
省份名称。 |
city |
String |
城市名称。 |
referer |
String |
来源域名。 |
device |
String |
设备类型。 |
operating_system |
String |
操作系统。 |
browser |
String |
浏览器类型。 |
terminal |
String |
终端类型。 |
start_time |
String |
开始播放时间。 |
end_time |
String |
结束播放时间。 |
返回示例
{
"play_logs": {
"play_log": [
{
"upid": 4874841499354241000,
"userid": "CC443A6686737xxx",
"videoid": "6D080640AF53B5D363835A29B2A11xxx",
"custom_id": "record1",
"play_duration": 20000,
"play_position": 9622,
"video_duration": 262686,
"ip": "202.189.0.2",
"province": "北京市",
"city": "北京市",
"referer": "www.bokecc.com",
"device": "PC",
"operating_system": "WIN7",
"browser": "IE 11",
"terminal": "PC",
"start_time": "2017-07-06 23:17:29",
"end_time": "2017-07-06 23:17:49"
},
......
]
}
}