高级分析-分页查询观看行为列表

接口URL

http://api.polyv.net/v2/advance/play/{userid}

接口说明

(接口调用有频率限制,详细请查看)

  1. 高级分析功能介绍详见: 视频高级分析
  2. 由于数据量和计算量大,当天的数据分析结果次日才可查询。

返回结果支持格式

JSON

请求方式

GET

请求参数

参数名 必选 类型及范围 说明
ptime true string 当前时间的毫秒级时间戳(13位),30分钟内有效
sign true string 签名
userid true string 用户id(拼接在url,无需另外传参数)
start false string 开始时间,格式为yyyy-MM-dd或者yyyy-MM-dd HH:mm:ss,查询范围不超过31天
end false string 结束时间,格式为yyyy-MM-dd或者yyyy-MM-dd HH:mm:ss,查询范围不超过31天
pageSize false int 每页取多少条数据(最大为20,超过则默认取20条数据)
viewerId false string 观众id
viewerName false string 观众昵称
vid false string 视频id
token false string 下一页的凭证,从当前页的返回数据里获取,第一页不需要传

时间参数说明

  • 查询的时间跨度不超过31天;
  • 当start有值而end为空时,返回开始日期后31天后的数据;
  • 当start为空而end不为空时,返回结束日期前31天内的数据;
  • 当start、end参数均为空时,返回最近31天的数据。

注意事项

所有有值的参数,按照字母排序方式以key=value&key=value的格式串起来,最后拼上secretkey,以SHA-1方式加密并全部大写化。(注意,当参数没有传递,或者传递了空值,sign不需要将此参数计算进去)

例如:api传递了ptime,vid。ptime为1,vid为test1,userid对应用户的secretkey为test2
则sign的值为:ptime=1&vid=test1test2经过SHA-1加密后大写化为: C2B1558D697EA3AF4ED2FC90152751860C1E2163。

返回错误结果JSON示例

{
  "code": 400,
  "status": "error",
  "message": "ptime is too old.",
  "data": ""
}

返回正确结果JSON示例

{
  "code": 200,
  "status": "success",
  "message": "success",
  "data": {
    "pageSize": 3,
    "contents": [
      {
        "startTime": "2019-10-01 11:12:05",
        "videoId": "xxxxxx",
        "videoName": "test video",
        "videoImage": "//img.videocc.net/uimage/xxxxxx.jpg",
        "videoDuration": 100,
        "deviceClass": "Phone",
        "osName": "Android",
        "osVersion": "Unknown",
        "agentName": "Unknown",
        "agentVersion": "Unknown",
        "referer": "N/A",
        "ip": "127.0.0.1",
        "country": "中国",
        "province": "广东",
        "city": "未知",
        "isp": "中国电信",
        "viewerId": "1234567890",
        "viewerNickName": "N/A",
        "viewerAvatar": "N/A",
        "totalVideoCount": 100,
        "heatmap": "[\"0-1:1\",\"2-3:1\"]",
        "completionRate": 0.02,
        "status": 61
      },
      {
        "startTime": "2019-10-01 11:12:05",
        "videoId": "xxxxxx",
        "videoName": "test video",
        "videoImage": "//img.videocc.net/uimage/xxxxxx.jpg",
        "videoDuration": 100,
        "deviceClass": "Phone",
        "osName": "Android",
        "osVersion": "Unknown",
        "agentName": "Unknown",
        "agentVersion": "Unknown",
        "referer": "N/A",
        "ip": "127.0.0.1",
        "country": "中国",
        "province": "广东",
        "city": "未知",
        "isp": "中国电信",
        "viewerId": "1234567890",
        "viewerNickName": "N/A",
        "viewerAvatar": "N/A",
        "totalVideoCount": 100,
        "heatmap": "[\"0-50:1\"]",
        "completionRate": 0.5,
        "status": 61
      },
      {
        "startTime": "2019-10-01 11:12:05",
        "videoId": "xxxxxx",
        "videoName": "test video",
        "videoImage": "//img.videocc.net/uimage/xxxxxx.jpg",
        "videoDuration": 100,
        "deviceClass": "Phone",
        "osName": "Android",
        "osVersion": "Unknown",
        "agentName": "Unknown",
        "agentVersion": "Unknown",
        "referer": "N/A",
        "ip": "127.0.0.1",
        "country": "中国",
        "province": "广东",
        "city": "未知",
        "isp": "中国电信",
        "viewerId": "1234567890",
        "viewerNickName": "N/A",
        "viewerAvatar": "N/A",
        "totalVideoCount": 100,
        "heatmap": "[\"0-50:1\"]",
        "completionRate": 0.5,
        "status": 61
      }
    ],
    "token": "xxxxxxxxxxxxxxx",
    "hasNextPage": true
  }
}

返回结果data表示成功修改的数量.

字段说明

字段 说明
code 返回码
status 返回状态
message 返回信息
data 操作结果

数据对象字段说明

字段 说明
startTime 首次观看日期
videoId 视频id
videoName 视频名称
videoImage 视频首图(没有添加协议头)
videoDuration 视频时长
deviceClass 设备名称
osName 操作系统
agentName 终端名称
agentVersion 终端版本
referer 来源
ip ip地址
country 国家
province 省份
city 地区
isp 运营商
viewerid 观众id
viewerNickName 观众昵称
viewerAvatar 观众头像
totalVideoCount 观众看的视频总量
heatmap 热力图(["0-1:1","3-4:2"]表示视频的0到1秒有1次观看,3到4秒有2次观看)
completionRate 观看完成度
status 视频的状态
token 查询下一页时传的凭证
hasNextPagetoken 是否有下一页

响应代码与响应信息对应

code message data 说明
400 sign can not be empty. 加密串为空
400 ptime is too old. 时间戳过期
400 ptime is illegal. ptime超出当前时间3分钟
400 Could not find user by userid. userid不存在
400 the sign is not right. 加密串错误
401 start date or end date is illegal. start或者end参数格式有问题
402 date range exceeds 31 days. start和end参数相差超过31天
403 get play list error. 后台获取数据失败
500 get play list failed. please check the backend log. 后台抛异常
200 success 查询到的数据 查询成功

PHP示例代码

<?php
header("Content-type: text/html; charset=utf-8");
$userid="3828390191";
//$jsonp="a";
$ptime=time()*1000;//13位
$start="2019-10-15";
$secretkey="tIQp4ATe9Z";
if(empty($jsonp)){
  $str="start=".$start."&ptime=".$ptime.$secretkey;
}else{
  $str="jsonp=".$jsonp."&start=".$start."&ptime=".$ptime.$secretkey;
}
echo $str.'';
$hash=strtoupper(sha1($str));
echo $hash.'';
$url="http://api.polyv.net/v2/advance/play/{$userid}?start={$start}&ptime={$ptime}&sign={$hash}";
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

$output = curl_exec($ch);
curl_close($ch);
//打印获得的数据
print_r($output);
?>

签名规则:

将非空的请求参数按照参数名字典顺序排列,连接参数名与参数值,并在尾部加上secretkey,生成40位大写SHA1值,作为sign。 以下是示例过程:

1、请求参数为

"ptime" = "1493188350000"
"playauth" = "1"

2、将请求参数按照参数名字典顺序排列

"playauth" = "1"
"ptime" = "1493188350000"

3、连接字符串
连接参数名与参数值,并在尾部加上secretkey(secretkey的值为tIQp4ATe9Z),如下:

playauth=1&ptime=1493188350000tIQp4ATe9Z

4、生成签名sign

7198CB4BAE7484C01EA1A1566D0210FF18EA1849
以上内容是否对您有帮助?根本没有帮助文档较差文档一般文档不错文档很好
Loading...