# 查询视频统计汇总数据

### 接口描述

```
1、批量查询视频播放统计汇总数据
2、从播放行为产生到数据可查询的间隔时间为1~2小时，流量消耗（flowSize字段）的计算依赖于CDN日志，为了保证数据完整性，流量数据需要间隔一个自然日才会生成
3、接口支持https协议
```

### 接口URL

```
http://api.polyv.net/v2/summary/video
```

[在线API调用](https://git.polyv.net/help-center/document-center/-/blob/master/req.html?api=http:/api.polyv.net/v2/summary/video/README.md)

### 请求方式

```
GET
```

### 接口约束

1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，[详细请查看](https://git.polyv.net/help-center/document-center/-/blob/master/vod/api/limit/README.md)

2、请求参数中startDate（开始日期）与endDate（结束日期）需要同时传入，仅传一个参数不生效

3、同时传入dr（时间段）与startDate、endDate的情况下，仅startDate、endDate有效；都不传则dr为默认值7days

### 请求参数描述

| 参数名       | 必选    | 类型     | 说明                                                                                                                                                                                                        |
| --------- | ----- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| userid    | true  | String | 保利威点播账户id，可以参考【[获取密匙](https://git.polyv.net/help-center/document-center/-/blob/master/vod/api/getSecretKey/README.md)】获取，获取路径：官网->登录->点播（API接口）                                                           |
| ptime     | true  | Long   | 当前时间的毫秒级时间戳，3分钟内有效                                                                                                                                                                                        |
| sign      | true  | String | 签名，为40位大写的SHA1值,`生成签名的secretkey密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据`【详见[签名生成规则](https://git.polyv.net/help-center/document-center/-/blob/master/vod/api/buildSign/README.md)】 |
| vids      | false | String | <p>视频id，多个视频以英文逗号分隔，例如：a2dc4f25179499d6586362672838cc2d_a,a2dc4f25179499d6586362672838cc2d_a 一次最多只能传100个视频id<br>不传时则查整个账号的数据</p>                                                                          |
| dr        | false | String | <p>时间段，默认值为7days（7days包含今天）<br>today：今天<br>yesterday：昨天<br>this_week：本周<br>last_week：上周<br>7days：最近7天<br>this_month：本月<br>last_month：上个月<br>this_year：今年<br>last_year：去年</p>                              |
| startDate | false | String | 开始日期，格式为：yyyy-MM-dd，例如：2021-03-01                                                                                                                                                                         |
| endDate   | false | String | 结束日期，格式为：yyyy-MM-dd，例如：2021-03-30，跨度最大为一年，可跨年查询                                                                                                                                                           |

### 示例

```requestUrl
http://api.polyv.net/v2/summary/video?vids=1b448be323251079dabeb2066d70fd44_1%2Cabc&sign=8631D872371A8D3BB37C03D261EA5B4AC70AA1D0&ptime=1631245812623&userid=1b448be323&dr=this_year
```

### 响应参数描述

| 参数名     | 类型      | 说明                                                                                                                                                                                |
| ------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| code    | Integer | 响应状态码，200为成功返回，非200为失败【详见[全局错误说明](https://git.polyv.net/help-center/document-center/-/blob/master/vod/api/errorInfo/README.md)】                                                   |
| status  | String  | 响应状态文本信息                                                                                                                                                                          |
| message | String  | 响应描述信息，当code为400或者500的时候，辅助描述错误原因                                                                                                                                                 |
| data    | Array   | 响应成功时返回视频统计汇总数据【详见[data字段描述](https://git.polyv.net/help-center/document-center/-/blob/master/vod/api/statistics/get_summary_data.md?id=data%E5%AD%97%E6%AE%B5%E6%8F%8F%E8%BF%B0)】 |

#### data字段描述

| 参数名                | 类型     | 说明            |
| ------------------ | ------ | ------------- |
| videoId            | String | 视频id          |
| pcVideoView        | String | pc端播放量        |
| mobileVideoView    | String | 移动端播放量        |
| pcUniqueViewer     | String | pc端唯一观众量      |
| mobileUniqueViewer | String | 移动端唯一观众量      |
| pcFlowSize         | Long   | pc端消耗流量，单位：字节 |
| mobileFlowSize     | Long   | 移动端消耗流量，单位：字节 |

### Java请求示例

快速接入基础代码请下载相关依赖源码， [点击下载源代码](https://git.polyv.net/help-center/document-center/-/blob/master/third_res/util.zip) ,下载后加入到自己的源码工程中即可。测试用例中的**HttpUtil.java 和 VodSignUtil.java** 都包含在下载文件中。

> 强烈建议您使用[点播Java SDK](https://git.polyv.net/help-center/document-center/-/blob/master/vod/java/README.md)完成API的功能对接，点播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。

```java
private static final Logger log = LoggerFactory.getLogger(VodStatisticsTest.class);
/**
 * 查询视频统计汇总数据
 */
@Test
public void videoSummaryData() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String secretKey = super.secretKey;
    String userId = super.userId;
    String timestamp = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "http://api.polyv.net/v2/summary/video";
    String vids = "1b448be323251079dabeb2066d70fd44_1,abc";
    String dr = "this_year";
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("ptime", timestamp);
    requestMap.put("dr", dr);
    requestMap.put("vids", vids);
    requestMap.put("userid", userId);
    requestMap.put("sign", VodSignUtil.getSign(requestMap, secretKey));
    String response = HttpUtil.get(url, requestMap);
    log.info("测试查询视频统计汇总数据：{}", response);
    //do somethings
        
}
```

### 响应示例

系统全局错误说明详见[全局错误说明](https://git.polyv.net/help-center/document-center/-/blob/master/vod/api/errorInfo/README.md)

成功示例

```json
{
    "code": 200,
    "status": "success",
    "message": "success",
    "data": [
        {
            "videoId": "1b448be323251079dabeb2066d70fd44_1",
            "pcVideoView": "8",
            "mobileVideoView": "0",
            "pcUniqueViewer": "8",
            "mobileUniqueViewer": "0",
            "pcFlowSize": 61335157,
            "mobileFlowSize": 0
        },
        {
            "videoId": "abc_a",
            "pcVideoView": "invalid vid",
            "mobileVideoView": "invalid vid",
            "pcUniqueViewer": "invalid vid",
            "mobileUniqueViewer": "invalid vid"
        }
    ]
}
```

异常示例

```json
{
    "code": 400,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}
```

若是批量传vid的形式，正常的vid数据会正常返回，异常的vid则返回'invalid vid'

```json
{
    "code": 200,
    "status": "success",
    "message": "success",
    "data": [
        {
            "videoId": "1b448be323251079dabeb2066d70fd44_1",
            "pcVideoView": "2",
            "mobileVideoView": "0",
            "pcUniqueViewer": "2",
            "mobileUniqueViewer": "0",
            "pcFlowSize": 11827449,
            "mobileFlowSize": 0
        },
        {
            "videoId": "aaabbb",
            "pcVideoView": "invalid vid",
            "mobileVideoView": "invalid vid",
            "pcUniqueViewer": "invalid vid",
            "mobileUniqueViewer": "invalid vid"
        }
    ]
}
```
