获取用户实时自定义参数播放记录日志

更新时间：2024-1-9

1. v2版本

接口描述
该接口用于获取用户实时自定义参数播放记录日志，v2接口请求参数跟v1一致，返回数据在v1基础上新增点击投屏时间。
请求地址
https://spark.bokecc.com/api/playlog/custom/realtime/v2
请求方式
GET
请求参数

以下请求参数需要进行THQS权限认证， 权限认证方式请参考THQS认证方式。

名称 类型 必填 描述
userid String 是 用户ID。
starttime String 是 开始日期，格式：yyyy-MM-dd。
endtime String 是 结束日期，格式：yyyy-MM-dd。
videoid String 否 视频ID。
customid String 否 自定义ID。
page Integer 否 分页参数，页码，默认为1。取值范围：大于0的整数。
num_per_page Integer 否 分页参数，每页显示数量，默认为10。取值范围：1~5000之间的任意整数。
请求示例
https://spark.bokecc.com/api/playlog/custom/realtime/v2?endtime=2022-11-31&starttime=2022-11-06&time=1670816443105&userid=xxxxxx&hash=1EC67C684470EE612AAE82769869C61D
返回数据
名称 类型 说明
play_logs Object 播放日志。
play_logs说明
名称 类型 说明
total Integer 总数。
play_log Array 播放日志信息。
play_log说明
名称 类型 说明
upid Integer 每次播放时产生的随机数字。
userid String 用户ID。
videoid String 视频ID。
custom_id String 自定义ID。
terminal_type String 播放终端类型。
ip String IP。
country String IP所属国家。
region String 客户端IP所属地区(省份)。
city String 客户端IP所属城市。
isp String 客户端IP网络运营商。
browser_name String 客户端使用的浏览器名称。
browser_version String 客户端使用的浏览器版本。
operating_system_name String 客户端使用的操作系统类型。
operating_system_version String 客户端使用的操作系统版本。
device_name String 客户端使用的设备名称。
device_brand String 客户端使用的设备品牌。
play_url String 本次播放的视频地址。
play_referer String 本次播放的来源地址。
video_duration Long 视频时长，单位：毫秒。
start_date_time String 播放开始时间，格式yyyy-MM-dd'T'HH:mm:ss.SSS'Z'。
finish_date_time String 播放结束时间，格式yyyy-MM-dd'T'HH:mm:ss.SSS'Z'。
finish_position Long 播放结束位置，单位：毫秒。
play_time Long 播放状态时长，单位：毫秒。
normal_play_time Long 1倍速播放状态时长，单位：毫秒。
unique_play_time Long 去重播放状态时长，单位：毫秒。
view_duration Long 去重观看视频时长，单位：毫秒。
click_screen_casting_times Array 点击投屏时间集合，单位：时间戳（毫秒）。
返回示例
{
    "play_logs": {
        "total": 1,
        "play_log": [
            {
                "browser_name": "Chrome",
                "browser_version": "Chrome 120.0.0.0",
                "city": "北京",
                "click_screen_casting_times": [
                    1703840038000,
                    1703840046000
                ],
                "country": "中国",
                "custom_id": "preview",
                "device_brand": "Apple",
                "device_name": "Mac",
                "finish_date_time": "2023-12-29T16:55:50.000Z",
                "finish_position": 149535,
                "ip": "103.90.191.98",
                "isp": "联通",
                "normal_play_time": 300000,
                "operating_system_name": "Mac OS X",
                "operating_system_version": "Mac OS X 10.15.7",
                "play_referer": "https://p.bokecc.com/qrplay.bo?uid=1CA01669312B0364&vid=EF66A10AEDCF214F9C33DC5901307461",
                "play_time": 300000,
                "play_url": "",
                "region": "北京",
                "start_date_time": "2023-12-29T16:53:20.000Z",
                "terminal_type": "H5-PC端",
                "unique_play_time": 296000,
                "upid": 6653301703839994543,
                "userid": "1CA01669312B0364",
                "video_duration": 427072,
                "videoid": "EF66A10AEDCF214F9C33DC5901307461",
                "view_duration": 296000
            }
        ]
    }
}

2. v1版本

接口描述
该接口用于获取用户实时自定义参数播放记录日志。
请求地址
https://spark.bokecc.com/api/playlog/custom/realtime
请求方式
GET
请求参数

以下请求参数需要进行THQS权限认证， 权限认证方式请参考THQS认证方式。

名称 类型 必填 描述
userid String 是 用户ID。
starttime String 是 开始日期，格式：yyyy-MM-dd。
endtime String 是 结束日期，格式：yyyy-MM-dd。
videoid String 否 视频ID。
customid String 否 自定义ID。
page Integer 否 分页参数，页码，默认为1。取值范围：大于0的整数。
num_per_page Integer 否 分页参数，每页显示数量，默认为10。取值范围：1~5000之间的任意整数。
请求示例
https://spark.bokecc.com/api/playlog/custom/realtime?endtime=2022-11-31&starttime=2022-11-06&time=1670816443105&userid=xxxxxx&hash=1EC67C684470EE612AAE82769869C61D
返回数据
名称 类型 说明
play_logs Object 播放日志。
play_logs说明
名称 类型 说明
total Integer 总数。
play_log Array 播放日志信息。
play_log说明
名称 类型 说明
upid Integer 每次播放时产生的随机数字。
userid String 用户ID。
videoid String 视频ID。
custom_id String 自定义ID。
terminal_type String 播放终端类型。
ip String IP。
country String IP所属国家。
region String 客户端IP所属地区(省份)。
city String 客户端IP所属城市。
isp String 客户端IP网络运营商。
browser_name String 客户端使用的浏览器名称。
browser_version String 客户端使用的浏览器版本。
operating_system_name String 客户端使用的操作系统类型。
operating_system_version String 客户端使用的操作系统版本。
device_name String 客户端使用的设备名称。
device_brand String 客户端使用的设备品牌。
play_url String 本次播放的视频地址。
play_referer String 本次播放的来源地址。
video_duration Long 视频时长，单位：毫秒。
start_date_time String 播放开始时间，格式yyyy-MM-dd'T'HH:mm:ss.SSS'Z'。
finish_date_time String 播放结束时间，格式yyyy-MM-dd'T'HH:mm:ss.SSS'Z'。
finish_position Long 播放结束位置，单位：毫秒。
play_time Long 播放状态时长，单位：毫秒。
normal_play_time Long 1倍速播放状态时长，单位：毫秒。
unique_play_time Long 去重播放状态时长，单位：毫秒。
view_duration Long 去重观看视频时长，单位：毫秒。
返回示例
{
    "play_logs": {
        "total": 32,
        "play_log": [
            {
                "browser_name": "Chrome",
                "browser_version": "Chrome 104.0.0.0",
                "city": "北京",
                "country": "中国",
                "custom_id": "preview",
                "device_brand": "Apple",
                "device_name": "Mac",
                "finish_date_time": "2022-11-27T19:14:51.000Z",
                "finish_position": 439240,
                "ip": "103.90.191.98",
                "isp": "联通",
                "normal_play_time": 440000,
                "operating_system_name": "Mac OS X",
                "operating_system_version": "Mac OS X 10.15.7",
                "play_referer": "https://console.bokecc.com/vod/videocenter/videomanage",
                "play_time": 440000,
                "play_url": "https://xxx.play.bokecc.com/flvs/xx/xx/xxx.mp4",
                "region": "北京",
                "start_date_time": "2022-11-27T19:07:31.000Z",
                "terminal_type": "H5-PC端",
                "unique_play_time": 439000,
                "upid": 1923871669547257394,
                "userid": "xxxxxxxxxxxxxxx",
                "video_duration": 439240,
                "videoid": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
                "view_duration": 439000
            }
        ]
    }
}

results matching ""

    No results matching ""