查询视频观众量统计数据

接口URL

https://api.polyv.net/v2/data/visitor/{userid}

接口说明

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

按照日期区间或区段及视频ID查询视频的观众量统计数据,不传vid参数就表示查询用户下所有视频的观众量。
从播放行为产生到数据可查询的间隔时间为1~2小时。

返回结果支持格式

JSON

请求方式

GET

请求参数

参数名 必选 类型及范围 说明
userid true string 用户id,路径参数
ptime true string 当前13位毫秒级时间戳,3分钟内有效
sign true string 签名,40位大写的sha1值
dr false string 时间段,具体值为以下几个:today(今天),yesterday(昨天),this_week(本周),last_week(上周),7days(最近7天),this_month(本月),last_month(上个月),this_year(今年),last_year(去年),默认值为7days
startDate false string 开始日期,格式为yyyy-MM-dd
endDate false string 结束日期,格式为yyyy-MM-dd
vid false string 单个视频ID

返回结果

{
"code": 200,
"status": "success",
"message": "success",
"data": [
{
"date": "2018-07-09",
"pcUniqueViewer": 0,
"mobileUniqueViewer": 0,
"totalUniqueViewer": 0
}
]
}

失败返回json(不带jsonp)

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

字段描述

字段名称 描述
date 日期
pcUniqueViewer pc端的观看量
mobileUniqueViewer 移动端的观看量
totalUniqueViewer 总的观众量

响应说明

错误代码 message 说明
400 sign can not be empty. 加密串为空
400 ptime is too old. 时间戳过期
400 ptime is illegal. 时间戳参数格式不对或者超过当前时间3分钟
400 Could not find user by userid. userid不存在
400 the sign is not right. 加密串不正确
401 start and end illegal. start日期大于end日期
500 query failed. 后台程序抛异常
200 success 提交成功

PHP请求示例

<?php
header("Content-type: text/html; charset=utf-8");
$userid="用户id";
$dr="this_year";
$ptime=time()*1000;//13位
$secretkey="填写secretkey";
$str="dr=".$dr."&ptime=".$ptime.$secretkey;

$hash=strtoupper(sha1($str));
$url="http://api.polyv.net/v2/data/visitor/$userid?ptime=$ptime&sign=$hash&dr=$dr";
$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 = "1492591990000"
vid = "382839019131be68715e9455f8d0971a_3"
format = "json"

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

format = "json"
ptime = "1492591990000"
vid = "382839019131be68715e9455f8d0971a_3"

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

format=json&ptime=1492591990000&vid=382839019131be68715e9455f8d0971a_3tIQp4ATe9Z

4、生成签名sign

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

查询视频播放地理位置统计数据

接口URL

https://api.polyv.net/v2/geo/{userid}

接口说明

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

  1. 按照日期区间或区段查询视频播放地理位置统计数据
  2. 从播放行为产生到数据可查询的间隔时间为1~2小时,但是统计结果中流量消耗(PCFlowSize、mobileFlowSize字段)的计算依赖于CDN日志,为了保证数据完整性,流量数据需要间隔一个自然日才会生成。例如1号产生的流量消耗,会在2号晚上汇总计算,在3号才可查询到流量数据。

返回结果支持格式

JSON

请求方式

GET

请求参数

参数名 必选 类型及范围 说明
userid true string 用户id,路径参数
ptime true string 当前13位毫秒级时间戳,3分钟内有效
sign true string 签名,40位大写的sha1值
dr false string 时间段,具体值为以下几个:today(今天),yesterday(昨天),this_week(本周),last_week(上周),7days(最近7天),this_month(本月),last_month(上个月),this_year(今年),last_year(去年),默认值为7days
start false string 开始日期,格式为yyyy-MM-dd
end false string 结束日期,格式为yyyy-MM-dd

返回结果

{
code: 200,
status: "success",
message: "success",
data: [
{
province: "广东",
pcPlayDuration: 1698,
formatPcPlayDuration: "00:28:18",
pcFlowSize: 25646408,
pcVideoView: 52,
pcUniqueViewer: 20,
mobilePlayDuration: 205,
formatMobilePlayDuration: "00:03:25",
mobileFlowSize: 0,
mobileVideoView: 6,
mobileUniqueViewer: 5
}
]
}

失败返回json(不带jsonp)

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

字段描述

字段名称 描述
province 省份
pcPlayDuration pc端播放时长,单位为秒
formatPcPlayDuration 播放时长,格式如00:00:00
pcFlowSize PC端消耗流量,单位字节
pcVideoView PC端播放量
pcUniqueViewer PC端观众量
mobilePlayDuration 移动端播放时长,单位为秒
formatMobilePlayDuration 移动端播放时长,格式如00:00:00
mobileFlowSize 移动端消耗流量,单位字节
mobileVideoView 移动端播放量
mobileUniqueViewer 移动端观众量

响应说明

错误代码 message 说明
400 sign can not be empty. 加密串为空
400 ptime is too old. 时间戳过期
400 ptime is illegal. 时间戳参数格式不对或者超过当前时间3分钟
400 Could not find user by userid. userid不存在
400 the sign is not right. 加密串不正确
401 start and end illegal. start日期大于end日期
500 query failed. 后台程序抛异常
200 success 提交成功

PHP请求示例

<?php
header("Content-type: text/html; charset=utf-8");
$userid="用户id";
$dr="this_year";
$ptime=time()*1000;//13位
$secretkey="填写secretkey";
$str="dr=".$dr."&ptime=".$ptime.$secretkey;

$hash=strtoupper(sha1($str));
$url="http://api.polyv.net/v2/geo/$userid?ptime=$ptime&sign=$hash&dr=$dr";
$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 = "1492591990000"
vid = "382839019131be68715e9455f8d0971a_3"
format = "json"

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

format = "json"
ptime = "1492591990000"
vid = "382839019131be68715e9455f8d0971a_3"

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

format=json&ptime=1492591990000&vid=382839019131be68715e9455f8d0971a_3tIQp4ATe9Z

4、生成签名sign

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

查询视频播放量统计数据接口

接口URL

http://api.polyv.net/v2/videoview/{userid}

接口说明

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

查询视频播放量统计数据接口,从播放行为产生到数据可查询的间隔时间为1~2小时。

返回结果支持格式

JSON

请求方式

GET

请求参数

参数名 必选 类型及范围 说明
vid false string 视频ID,不填vid会查所有视频的播放量统计数据
userid true string 用户id(在url中使用,请求的时候不需要提交)
ptime true string 当前13位毫秒级时间戳,3分钟内有效
sign true string 签名,40位大写的sha1值
dr false string 时间段,具体值为以下几个:today(今天),yesterday(昨天),this_week(本周),last_week(上周),7days(最近7天),this_month(本月),last_month(上个月),this_year(今年),last_year(去年),默认值为7days
period false string 显示周期,具体为以下几个值:daily(按日显示),weekly(按周显示),monthly(按月显示)。默认值为daily。period的值受限于dr的值,当dr的值为today,yesterday,this_week,last_week,7days时,period只能为daily,当dr的值为this_month,last_month时,period只能为daily或者weekly

返回结果

{
  "code": 200,
  "status": "success",
  "message": "success",
  "data": [
    {
      "currentTime": "2018-02-23",
      "pcVideoView": 0,
      "mobileVideoView": 0
    },
    {
      "currentTime": "2018-02-24",
      "pcVideoView": 0,
      "mobileVideoView": 0
    },
    {
      "currentTime": "2018-02-25",
      "pcVideoView": 23,
      "mobileVideoView": 0
    },
    {
      "currentTime": "2018-02-26",
      "pcVideoView": 63,
      "mobileVideoView": 2
    },
    {
      "currentTime": "2018-02-27",
      "pcVideoView": 11,
      "mobileVideoView": 0
    },
    {
      "currentTime": "2018-02-28",
      "pcVideoView": 6,
      "mobileVideoView": 0
    },
    {
      "currentTime": "2018-03-01",
      "pcVideoView": 0,
      "mobileVideoView": 0
    }
  ]
}

失败返回json(不带jsonp)

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

字段描述

字段名称 描述
currentTime 日期
pcVideoView pc端播放量
mobileVideoView 移动端播放量

响应说明

错误代码 message 说明
400 sign can not be empty. 加密串为空
400 ptime is too old. 时间戳过期
400 ptime is illegal. 时间戳参数格式不对或者超过当前时间3分钟
400 Could not find user by userid. userid不存在
400 the sign is not right. 加密串不正确
401 illegal vid. vid格式不正确,正确vid格式前面一段是userid
402 illegal period. period的值非法,请看请求参数里period的限制内容
500 query failed. 后台程序抛异常
200 success 提交成功

PHP请求示例

<?php
header("Content-type: text/html; charset=utf-8");
$userid="3828390191";
$dr="7days";
$period="daily";
$ptime=time()*1000;//13位
$vid="382839019131be68715e9455f8d0971a_3";
$secretkey="tIQp4ATe9Z";
//$jsonp="a";
if(empty($jsonp)){
    $str="dr=".$dr."&period=".$period."&ptime=".$ptime."&vid=".$vid.$secretkey;
}else{
    $str="dr=".$dr."&jsonp=".$jsonp."&period=".$period."&ptime=".$ptime."&vid=".$vid.$secretkey;
}
echo $str.'';
$hash=strtoupper(sha1($str));
echo $hash.'';
$url="http://api.polyv.net/v2/videoview/$userid?vid=$vid&ptime=$ptime&sign=$hash&dr=$dr&period=$period";
$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 = "1492591990000"
vid = "382839019131be68715e9455f8d0971a_3"
format = "json"

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

format = "json"
ptime = "1492591990000"
vid = "382839019131be68715e9455f8d0971a_3"

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

format=json&ptime=1492591990000&vid=382839019131be68715e9455f8d0971a_3tIQp4ATe9Z

4、生成签名sign

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

查询视频播放量排行接口

接口URL

http://api.polyv.net/v2/videoview/{userid}/ranklist

接口说明

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

查询视频播放量排行接口,从播放行为产生到数据可查询的间隔时间为1~2小时。

返回结果支持格式

JSON

请求方式

GET

请求参数

参数名 必选 类型及范围 说明
userid true string 用户id(在url中使用,请求的时候不需要提交)
ptime true string 当前13位毫秒级时间戳,3分钟内有效
sign true string 签名,40位大写的sha1值
dr false string 时间段,具体值为以下几个:today(今天),yesterday(昨天),7days(最近7天),30days(最近30天),默认值为7days,当start和end都不为空时,dr失效,当start和end其中一个为空,查询最近7天数据,当start和end都为空,以dr为准
start false string 开始日期,格式为yyyy-MM-dd
end false string 结束日期,格式为yyyy-MM-dd

返回结果

{
  "code": 200,
  "status": "success",
  "message": "success",
  "data": {
    "totalMoVideoView": 0,
    "pcVideoDailys": [
      {
        "videoId": "cca90d24f79b99f93f34f7650aaad66f_c",
        "title": "Wildlife",
        "duration": "00:00:30",
        "pcVideoView": 1,
        "mobileVideoView": 0
      },
      {
        "videoId": "cca90d24f7815cedaf40a2c0bbed526c_c",
        "title": "Wildlife",
        "duration": "00:00:30",
        "pcVideoView": 1,
        "mobileVideoView": 0
      },
      {
        "videoId": "cca90d24f7352b354c2b6b335f218d3a_c",
        "title": "",
        "duration": "",
        "pcVideoView": 1,
        "mobileVideoView": 0
      }
    ],
    "moVideoDailys": [
      {
        "videoId": "cca90d24f79b99f93f34f7650aaad66f_c",
        "title": "Wildlife",
        "duration": "00:00:30",
        "pcVideoView": 1,
        "mobileVideoView": 0
      },
      {
        "videoId": "cca90d24f7815cedaf40a2c0bbed526c_c",
        "title": "Wildlife",
        "duration": "00:00:30",
        "pcVideoView": 1,
        "mobileVideoView": 0
      },
      {
        "videoId": "cca90d24f7352b354c2b6b335f218d3a_c",
        "title": "",
        "duration": "",
        "pcVideoView": 1,
        "mobileVideoView": 0
      }
    ],
    "totalPcVideoView": 3
  }
}

失败返回json(不带jsonp)

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

字段描述

字段名称 描述
totalPcVideoView pc端总播放量
totalMoVideoView 移动端总播放量
pcVideoDailys pc端播放量排行列表
moVideoDailys 移动端播放量排行列表
videoId 视频vid
title 视频标题
duration 播放时长
pcVideoView pc端播放量
mobileVideoView 移动端播放量

响应说明

错误代码 message 说明
400 sign can not be empty. 加密串为空
400 ptime is too old. 时间戳过期
400 ptime is illegal. 时间戳参数格式不对或者超过当前时间3分钟
400 Could not find user by userid. userid不存在
400 the sign is not right. 加密串不正确
401 start and end illegal. start日期大于end日期
500 query failed. 后台程序抛异常
200 success 提交成功

PHP请求示例

<?php
header("Content-type: text/html; charset=utf-8");
$userid="3828390191";
$dr="7days";
$start="2017-12-30";
$end="2018-03-01";
$ptime=time()*1000;//13位
$secretkey="tIQp4ATe9Z";
//$jsonp="a";
if(empty($jsonp)){
    $str="dr=".$dr."&end=".$end."&ptime=".$ptime."&start=".$start.$secretkey;
}else{
    $str="dr=".$dr."&end=".$end."&jsonp=".$jsonp."&ptime=".$ptime."&start=".$start.$secretkey;
}
echo $str.'';
$hash=strtoupper(sha1($str));
echo $hash.'';
$url="http://api.polyv.net/v2/videoview/$userid/ranklist?ptime=$ptime&sign=$hash&dr=$dr&start=$start&end=$end";
$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 = "1492591990000"
vid = "382839019131be68715e9455f8d0971a_3"
format = "json"

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

format = "json"
ptime = "1492591990000"
vid = "382839019131be68715e9455f8d0971a_3"

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

format=json&ptime=1492591990000&vid=382839019131be68715e9455f8d0971a_3tIQp4ATe9Z

4、生成签名sign

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

查询播放域名统计数据接口

接口URL

http://api.polyv.net/v2/domain/{userid}

接口说明

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

  1. 查询播放域名统计数据接口
  2. 从播放行为产生到数据可查询的间隔时间为1~2小时。但是消耗流量(PCFlowSize字段)的计算依赖于CDN日志,为了保证数据完整性,流量数据需要间隔一个自然日才会生成。例如1号产生的流量消耗,会在2号晚上汇总计算,在3号才可查询到流量数据。

返回结果支持格式

JSON

请求方式

GET

请求参数

参数名 必选 类型及范围 说明
vid true string 视频ID
userid true string 用户id(在url中使用,请求的时候不需要提交)
ptime true string 当前13位毫秒级时间戳,3分钟内有效
sign true string 签名,40位大写的sha1值
dr false string 时间段,具体值为以下几个:today(今天),yesterday(昨天),this_week(本周),last_week(上周),7days(最近7天),this_month(本月),last_month(上个月),this_year(今年),last_year(去年),默认值为7days
start false string 开始日期,格式为yyyy-MM-dd
end false string 结束日期,格式为yyyy-MM-dd

返回结果

{
  "code": 200,
  "status": "success",
  "message": "success",
  "data": [
    {
      "domain": "my.polyv.net",
      "pcPlayDuration": 140,
      "pcFlowSize": 9783770,
      "pcVideoView": 4,
      "pcUniqueViewer": 1,
      "mobilePlayDuration": 0,
      "mobileVideoView": 0,
      "mobileUniqueViewer": 0
    },
    {
      "domain": "play.polyv.net",
      "pcPlayDuration": 22,
      "pcFlowSize": 1316151,
      "pcVideoView": 1,
      "pcUniqueViewer": 1,
      "mobilePlayDuration": 0,
      "mobileVideoView": 0,
      "mobileUniqueViewer": 0
    },
    {
      "domain": "player.polyv.net",
      "pcPlayDuration": 9,
      "pcFlowSize": 1316151,
      "pcVideoView": 1,
      "pcUniqueViewer": 1,
      "mobilePlayDuration": 0,
      "mobileVideoView": 0,
      "mobileUniqueViewer": 0
    }
  ]
}

失败返回json(不带jsonp)

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

字段描述

字段名称 描述
domain 域名
pcPlayDuration PC端播放时长(单位:秒)
pcFlowSize PC端消耗流量(单位:字节)
pcVideoView PC端总播放量
pcUniqueViewer PC端唯一观众数
mobilePlayDuration 移动端播放时长
mobileVideoView 移动端播放量
mobileUniqueViewer 移动端播放者数量

响应说明

错误代码 message 说明
400 sign can not be empty. 加密串为空
400 ptime is too old. 时间戳过期
400 ptime is illegal. 时间戳参数格式不对或者超过当前时间3分钟
400 Could not find user by userid. userid不存在
400 the sign is not right. 加密串不正确
401 start and end illegal. start日期大于end日期
500 query failed. 后台程序抛异常
200 success 提交成功

PHP请求示例

<?php
header("Content-type: text/html; charset=utf-8");
$userid="3828390191";
$dr="7days";
$start="2017-12-30";
$end="2018-03-01";
$ptime=time()*1000;//13位
$secretkey="tIQp4ATe9Z";
//$jsonp="a";
if(empty($jsonp)){
    $str="dr=".$dr."&end=".$end."&ptime=".$ptime."&start=".$start.$secretkey;
}else{
    $str="dr=".$dr."&end=".$end."&jsonp=".$jsonp."&ptime=".$ptime."&start=".$start.$secretkey;
}
echo $str.'';
$hash=strtoupper(sha1($str));
echo $hash.'';
$url="http://api.polyv.net/v2/domain/$userid?ptime=$ptime&sign=$hash&dr=$dr&start=$start&end=$end";
$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、请求参数为

dr="7days"
start="2018-07-31"
end="2018-08-31"
ptime = "1492591990000"
vid = "382839019131be68715e9455f8d0971a_3"
jsonp="a"

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

dr="7days"
end="2018-08-31"
jsonp="a"
ptime = "1492591990000"
start="2018-07-31"

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

dr=7days&end=2018-08-31&jsonp=a&ptime=1535693911000&start=2018-07-31E8qVf7rCFo

4、生成签名sign

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

批量获取视频观看日志

接口URL

http://api.polyv.net/v2/viewlog/{userid}/monthly/{month}

接口说明

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

  1. 该接口可通过自然月批量获取视频观看日志
  2. 从播放行为产生到数据可查询的间隔时间为1~2小时。但是每条观看记录所消耗的流量计算(flowSize字段)依赖于CDN日志,为了保证数据完整性,流量数据需要间隔一个自然日才会生成。例如1号产生的流量消耗,会在2号晚上汇总计算,在3号才可查询到流量数据。

返回结果支持格式

JSON

请求方式

GET

请求数限制

TRUE

请求参数

参数名 必选 类型及范围 说明
userid true string POLYV用户ID
month true string 查询月份,格式为yyyyMM
ptime true string 当前时间的毫秒级时间戳(13位),3分钟内有效
sign true string 签名,为40位大写的SHA1值
numPerPage false int 每一页的大小,默认为99
pageNum false int 第几页,默认为1
start false string 查询开始日期,格式为yyyy-MM-dd
end false string 查询结束日期,格式为yyyy-MM-dd
vid false string 所查询视频vid,当vid为空时,查询该用户所有视频的日志
sessionId false string 用户自定义ID
currentDay false string 月内某一天的数据,格式为yyyy-MM-dd

注意事项

sign的拼接规则是:month=变量&numPerPage=变量&pageNum=变量&ptime=变量secrectKey,再经过SHA-1加密并大写化。
这里要注意,如果这些参数的值为空串,则sign里就不用拼上这些变量

返回正确结果JSON示例

{
  "code": 200,
  "status": "success",
  "message": "success",
  "data": [
    {
      "playId": "1483692000578X1164631",
      "userId": "cca90d24f7",
      "videoId": "cca90d24f752ef74a0200a01bbac9488_c",
      "playDuration": 25,
      "stayDuration": 97,
      "currentTimes": 558,
      "duration": 1539,
      "flowSize": 21144147,
      "sessionId": "",
      "param1": "",
      "param2": "",
      "param3": "",
      "param4": "",
      "param5": "",
      "ipAddress": "59.42.28.226",
      "country": "中国",
      "province": "广东",
      "city": "广州",
      "isp": "电信",
      "referer": "http://my.polyv.net/front/video/preview?vid=cca90d24f752ef74a0200a01bbac9488_c",
      "userAgent": "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/55.0.2883.87 Safari/537.36",
      "operatingSystem": "Windows",
      "browser": "Chrome",
      "isMobile": "N",
      "currentDay": "2017-01-06",
      "currentHour": 16,
      "viewSource": "vod_pc_html5",
      "createdTime": 1483692131000,
      "lastModified": 1483694042000
    },
    {
      "playId": "1483670488973X1301441",
      "userId": "cca90d24f7",
      "videoId": "cca90d24f752ef74a0200a01bbac9488_c",
      "playDuration": 477,
      "stayDuration": 538,
      "currentTimes": 532,
      "duration": 1539,
      "flowSize": 56641657,
      "sessionId": "",
      "param1": "",
      "param2": "",
      "param3": "",
      "param4": "",
      "param5": "",
      "ipAddress": "59.42.28.226",
      "country": "中国",
      "province": "广东",
      "city": "广州",
      "isp": "电信",
      "referer": "http://my.polyv.net/secure/video/",
      "userAgent": "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/55.0.2883.87 Safari/537.36",
      "operatingSystem": "Windows",
      "browser": "Chrome",
      "isMobile": "N",
      "currentDay": "2017-01-06",
      "currentHour": 10,
      "viewSource": "vod_pc_html5",
      "createdTime": 1483670565000,
      "lastModified": 1483673176000
    }
  ],
  "total": 3
}

返回错误结果JSON示例

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

字段说明

字段 说明
code 返回码
status 返回状态
message 返回信息
data 分类下的视频大小
playId 表示此次播放动作的ID
userId 用户ID
videoId 视频ID
playDuration 播放时长 (用户观看的总时间 ,例如:18:00开始看一个视频,看到了18:30,这30分钟就是播放时长)
stayDuration 缓存时长
currentTimes 播放时间 (用户观看的最后时间,例如:停止观看视频的时候,进度条最后的分钟数为35分钟,播放时间就是35分钟)
duration 视频总时长
flowSize 流量大小
sessionId 用户自定义参数,如学员ID等 ,该参数做了UrlSafeBase64的加密,需要做解密
param1/2/3/4/5 POLYV系统参数
ipAddress IP地址
country 国家
province 省份
city 城市
isp ISP运营商
referer 播放视频页面地址
userAgent 用户设备
operatingSystem 操作系统
browser 浏览器
isMobile 是否为移动端
currentDay 日志查询日期 (格式为:yyyy-MM-dd)
currentHour 日志查看时间
viewSource 用户观看渠道,取值有:vod_ios_sdk、vod_android_sdk、vod_flash、vod_pc_html5、vod_wechat_mini_program、vod_mobile_html5
createdTime 日志创建时间 (格式为13位的时间戳)
lastModified 日志更新日期 (格式为13位的时间戳)

php请求示例

<?php
$userid="efbb4ae8ac";
$month="201709";//查询月份,格式为yyyyMM
$ptime = time()*1000;
$numPerPage=1000;
$pageNum=1;
$secrectKey = "hbjCVBhnth";
$sign=strtoupper(sha1("month=$month&numPerPage=$numPerPage&pageNum=$pageNum&ptime=$ptime".$secrectKey));
$url="http://api.polyv.net/v2/viewlog/$userid/monthly/$month?month=$month&ptime=$ptime&numPerPage=$numPerPage&pageNum=$pageNum&sign=$sign";
$ch=curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_HEADER, 0);
$output = curl_exec($ch);
curl_close($ch);
print_r($output);
?>

响应代码与响应信息对应

code message 说明
400 ptime is illegal. 时间戳格式问题,或者时间戳超过当前时间3分钟
400 sign can not be empty. 加密串为空
400 Could not find user by userid. 用户id不存在
400 ptime is too old. 时间戳过期(3分钟过期)
400 the sign is not right. 加密串错误
401 pageNum和numPerPage必须为大于0的正整数. 分页参数不正确
402 month必须为合法的yyyyMM格式. month格式内容不正确
500 查询失败. 后台发生错误异常
200 success 查询成功
以上内容是否对您有帮助?根本没有帮助文档较差文档一般文档不错文档很好
Loading...

获取某一天视频观看日志

接口URL

http://api.polyv.net/v2/data/{userid}/viewlog

接口说明

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

  1. 该接口可获取某一天视频观看日志
  2. 从播放行为产生到数据可查询的间隔时间为1~2小时。但是每条观看记录所消耗的流量计算(flowSize字段)依赖于CDN日志,为了保证数据完整性,流量数据需要间隔一个自然日才会生成。例如1号产生的流量消耗,会在2号晚上汇总计算,在3号才可查询到流量数据。

返回结果支持格式

JSON

请求方式

POST,GET

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
userid string POLYV用户ID,http://api.polyv.net/v2/data/{userid}/viewlog中的{userid}需要替换为POLYV用户ID的值
day string 查询某天的日志时间
ptime string 当前时间的毫秒级时间戳(13位),3分钟内有效
sign string 签名,为40位大写的SHA1值
type string 返回的数据格式为:json/xml
vid string 视频ID
cataid string 分类ID,注意视频ID(vid)和分类ID(cataid)为空时,获取账号当天所有视频日志;当vid为空、cataid不为空时,查询对应cataid下的日志;当vid不为空时查询对应vid的日志
sessionId string 用户自定义ID
viewerId string 用户自定义ID,当和sessionId同时传递时,会以viewerId为准

JSON示例

{
  code: 200,
  status: "success",
  message: "",
  data: [
  {
    playId: "1468389486891X1363716",
    userId: "3828390191",
    videoId: "3828390191ed924fbb387395ae6f3af5_3",
    playDuration: 13,
    stayDuration: 17,
    currentTimes: 14,
    duration: 1551,
    flowSize: 13638592,
    sessionId: "",
    param1: "",
    param2: "",
    param3: "",
    param4: "",
    param5: "160712",
    ipAddress: "120.197.57.62",
    country: "中国",
    province: "广东",
    city: "广州",
    isp: "",
    referer: "http://apollo.polyv.net/front/video/preview?vid=3828390191ed924fbb387395ae6f3af5_3",
    userAgent: "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/53.0.2767.5 Safari/537.36",
    operatingSystem: "Windows",
    browser: "Chrome",
    isMobile: "N",
    currentDay: "2016-07-13",
    currentHour: 13,
    viewSource: "vod_pc_html5",
    createdTime: 1468389527000,
    lastModified: 1468389563000
  }
  ]
}

字段说明

字段 说明
playId 表示此次播放动作的ID
userId 用户ID
videoId 视频ID
playDuration 播放时长,单位为秒 (用户观看的总时间 ,例如:18:00开始看一个视频,看到了18:30,这30分钟就是播放时长)
stayDuration 缓存时长,单位为秒
currentTimes 播放时间,单位为秒 (用户观看的最后时间,例如:停止观看视频的时候,进度条最后的分钟数为35分钟,播放时间就是35分钟)
duration 视频总时长,单位为秒
flowSize 流量大小,单位为字节
sessionId 用户自定义参数,如学员ID等
param1/2/3/4/5 POLYV系统参数
ipAddress IP地址
country 国家
province 省份
city 城市
isp ISP运营商
referer 播放视频页面地址
userAgent 用户设备
operatingSystem 操作系统
browser 浏览器
isMobile 是否为移动端
currentDay 日志查询日期 (格式为:yyyy-MM-dd)
currentHour 日志查看时间
viewSource 用户观看渠道,取值有:
vod_ios_sdk:ios端、vod_android_sdk:安卓端、vod_flash:flash、vod_wechat_mini_program:微信小程序、
vod_pc_html5:pc端web、vod_mobile_html5:移动端web、vod_mobile_html5_v2:移动端web v2
createdTime 日志创建时间 (格式为13位的时间戳)
lastModified 日志更新日期 (格式为13位的时间戳)

php请求示例

<?php
    $userid="e2e84a7383";
    $day="20160711";
    $readtoken="JZmdsRB4sD-OdmDKN2Rnm-bsFGj3Fi93";
    $secretkey="7UagtQOq2A";
    $ptime=time()*1000;
    $str="day=$day&ptime=$ptime&userid=$userid".$secretkey;
    $sign=strtoupper(sha1($str));
    $vid="e2e84a73839a7070861257c3612309e1_e";
    $url="http://api.polyv.net/v2/data/$userid/viewlog?day=$day&ptime=$ptime&sign=$sign&type=json&vid=$vid";
    $content = file_get_contents($url);
    echo $content;
?>

签名规则

将参数day, ptime, userid按照参数名字典顺序排列,用“&”连接参数名与参数值,并在最后加上secretkey的值,生成40位大写的SHA1值,作为sign。

以下是示例过程:

1. 将请求参数按照参数名字典顺序排列为:

day="20160711";
ptime="1468982782000";
userid="e2e84a7383";

2. 连接字符串 用“&”连接参数名与参数值,并在最后加上secretkey的值,生成40位大写的SHA1值,作为sign(本示例的值为7UagtQOq2A),如下:

day=20160711&ptime=1468982782000&userid=e2e84a73837UagtQOq2A

3. 生成签名sign

sign为40位大写的SHA1值:

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