# 查询后台频道统计信息

### 接口描述

```
1、查询后台频道统计信息

2、接口支持https协议
```

### 接口URL

```
http://api.polyv.net/live/v4/channel/statistics/channel-statistic
```

[在线API调用](https://git.polyv.net/help-center/document-center/-/blob/master/req.html?api=http:/api.polyv.net/live/v4/channel/statistics/channel-statistic/README.md)

### 请求方式

```
GET
```

### 接口约束

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

### 请求参数描述

| 参数名       | 必选   | 类型     | 说明                                                                                                                                                                                                        |
| --------- | ---- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| appId     | true | String | 账号appId【详见[获取密钥](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/getSecretKey/README.md)】                                                                                        |
| timestamp | true | String | 当前13位毫秒级时间戳，3分钟内有效                                                                                                                                                                                        |
| sign      | true | String | 签名，为32位大写的MD5值,`生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据`【详见[签名生成规则](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/buildSign/README.md)】 |
| channelId | true | String | 频道号                                                                                                                                                                                                       |
| endDate   | true | String | 结束日期，格式：yyyy-MM-dd                                                                                                                                                                                        |
| startDate | true | String | 开始日期，格式：yyyy-MM-dd                                                                                                                                                                                        |

### 示例

```requestUrl
https://api.polyv.net/live/v4/channel/statistics/channel-statistic?appId=frlr1zazn3&sign=739AE57DEEFD537131C7F30E85A35480&channelId=3346714&startDate=2023-07-01&endDate=2023-07-10&timestamp=1689046365000
```

### 响应参数描述

| 参数名       | 类型      | 说明                                       |
| --------- | ------- | ---------------------------------------- |
| code      | Integer | 状态码，与 http 状态码相同，用于确定基本的响应状态             |
| data      | Object  | 频道统计视图对象【详见[Data参数描述](#Data参数描述)】        |
| error     | Object  | 状态码非200时的错误信息【详见[Error参数描述](#Error参数描述)】 |
| requestId | String  | 请求ID，每次请求生成的唯一的 UUID，仅可用于排查、调试，不应该和业务挂上钩 |
| status    | String  | 响应结果，由业务决定，成功返回success，失败返回error         |
| success   | Boolean | 是否成功响应                                   |

### Data参数描述

| 参数名                         | 类型      | 说明                                                    |
| --------------------------- | ------- | ----------------------------------------------------- |
| averagePlayDuration         | Integer | 人均观看时长，为(观看时长/观看人数ips)向下取整，单位:分钟                      |
| averageTime                 | Float   | 人均观看次数，为(观看次数/观看人数ips)\*10后向下取整后再除10，所以有一位小数，单位：次     |
| ips                         | Integer | 观看人数（根据ip地址去重）                                        |
| viewers                     | Integer | 观看人数（根据viewerId计算）                                    |
| playDuration                | Integer | 观看时长，单位:分钟                                            |
| plays                       | Integer | 观看次数                                                  |
| uniqueVisitor               | Integer | 访问人数                                                  |
| statisticsByViewer          | String  | 是否根据viewerId统计平均观看时长和次数，Y是，N否                         |
| averagePlayDurationByViewer | Integer | 人均观看时长，为(观看时长/观看人数viewers)向下取整，单位:分钟                  |
| averageTimeByViewer         | Float   | 人均观看次数，为(观看次数/观看人数viewers)\*10后向下取整后再除10，所以有一位小数，单位：次 |

### Error参数描述

| 参数名  | 类型      | 说明                   |
| ---- | ------- | -------------------- |
| code | Integer | 错误代码，用于确定具体的错误原因     |
| desc | String  | 错误描述，与 error.code 对应 |

### Java请求示例

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

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

```java
private static final Logger log = LoggerFactory.getLogger(getClass());
/**
* 查询后台频道统计信息
* @throws IOException
* @throws NoSuchAlgorithmException
*/
@Test
public void statisticsChannelStatisticTest() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());

    //业务参数
    String url = "http://api.polyv.net/live/v4/channel/statistics/channel-statistic";
    String channelId = "";
    String endDate = "";
    String startDate = "";

    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("channelId", channelId);
    requestMap.put("endDate", endDate);
    requestMap.put("startDate", startDate);
    requestMap.put("timestamp", timestamp);

    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));

    String response = HttpUtil.get(url, requestMap);

    log.info("测试查询后台频道统计信息成功：{}", response);
    //do somethings

}
```

### 响应示例

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

成功示例

```json
{
    "code": 200,
    "status": "success",
    "requestId": "a5f8e520709b454f9741570aee9625c1.74.16890463649665219",
    "data": {
        "uniqueVisitor": 23,
        "plays": 71,
        "playDuration": 928,
        "ips": 24,
        "averagePlayDuration": 38,
        "averageTime": 2.9
    },
    "success": true
}
```

异常示例

```json
{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}
```
