# 查询频道终端分布数据统计

### 接口描述

```
1、查询频道观看终端分布统计信息
2、接口支持https协议
```

### 接口URL

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

### 请求方式

```
GET
```

### 接口约束

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

2、时间跨度最多90天

3、统计数据有30分钟延迟

### 请求参数描述

| 参数名       | 必选   | 类型     | 说明                                                                                                                                                                                                        |
| --------- | ---- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| appId     | true | String | 账号appId【详见[获取密钥](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/getSecretKey/README.md)】                                                                                        |
| timestamp | true | Long   | 当前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 | 频道号                                                                                                                                                                                                       |
| startTime | true | Long   | 开始时间，13位毫秒级时间戳                                                                                                                                                                                            |
| endTime   | true | Long   | 结束时间，13位毫秒级时间戳                                                                                                                                                                                            |

### 示例

```requestUrl
http://api.polyv.net/live/v4/channel/statistics/browser-summary?appId=frlr1zazn3&sign=BC1EE579585A98E69120E3350FE3DAC0&startTime=1651386101000&endTime=1652336501462&channelId=2272655&timestamp=1652414352304
```

### 响应参数描述

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

### Error参数描述

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

#### data参数描述

| 参数名          | 类型      | 说明                                  |
| ------------ | ------- | ----------------------------------- |
| name         | String  | 终端名称                                |
| platform     | String  | <p>终端类型<br>pc：PC端<br>mobile：移动端</p> |
| plays        | Integer | 观看次数                                |
| viewers      | Integer | 观看用户数（基于param1，即viewerId）           |
| ips          | Integer | 观看IP数                               |
| playDuration | Integer | 观看时长，单位:分钟                          |
| percent      | Double  | 百分比，保留两位小数（基于观看次数）                  |

### 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 getBrowsersSummaryTest() 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/browser-summary";
    String channelId = "2272655";
    String startTime = "1651386101000";
    String endTime = "1652336501462";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    requestMap.put("startTime", startTime);
    requestMap.put("endTime", endTime);
    
    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": "1375e52c9fc041a89ce61daf28f79737.58.16520842026550383",
    "data": [
        {
            "name": "Chrome",
            "platform": "pc",
            "plays": 101,
            "viewers": 11,
            "ips": 28,
            "playDuration": 586,
            "percent": 69.18
        },
        {
            "name": "weixin",
            "platform": "mobile",
            "plays": 29,
            "viewers": 13,
            "ips": 10,
            "playDuration": 49,
            "percent": 19.86
        },
        {
            "name": "Safari",
            "platform": "mobile",
            "plays": 11,
            "viewers": 4,
            "ips": 5,
            "playDuration": 12,
            "percent": 7.53
        },
        {
            "name": "android-sdk",
            "platform": "mobile",
            "plays": 4,
            "viewers": 1,
            "ips": 1,
            "playDuration": 24,
            "percent": 2.74
        },
        {
            "name": "Other",
            "platform": "mobile",
            "plays": 1,
            "viewers": 1,
            "ips": 1,
            "playDuration": 7,
            "percent": 0.68
        }
    ],
    "success": true
}
```

异常示例

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