> For the complete documentation index, see [llms.txt](https://polyv.gitbook.io/document/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://polyv.gitbook.io/document/docs/vod/api/statistics/get_geo_stat.md).
# 查询视频播放的地理位置分布
### 接口描述
```
1、通过日期区间查询视频播放地理位置统计数据
2、从播放行为产生到数据可查询的间隔时间为1~2小时
3、响应参数消耗流量（PCFlowSize字段）的计算依赖于CDN日志，为了保证数据完整性，流量数据需要间隔一个自然日才会生成
4、接口URL中的{userid}为点播账号userid，具体参考【获取密钥】
5、接口支持https协议
```
### 接口URL
```
http://api.polyv.net/v2/geo/{userid}
```
[在线API调用](https://git.polyv.net/help-center/document-center/-/blob/master/req.html?api=http:/api.polyv.net/v2/geo/%7Buserid%7D/README.md)
### 请求方式
```
GET
```
### 接口约束
1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，[详细请查看](https://git.polyv.net/help-center/document-center/-/blob/master/vod/api/limit/README.md)
2、请求参数中start（开始日期）与end（结束日期）需要同时传入，仅传一个参数不生效
3、同时传入dr（时间段）与start、end的情况下，仅start、end有效；都不传则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)】 |
| dr | false | String | 时间段，具体值为以下几个，默认值为7days
today：今天
yesterday：昨天
this\_week：本周
last\_week：上周
7days：最近7天
this\_month：本月
last\_month：上个月
this\_year：今年
last\_year：去年
|
| start | false | String | 开始日期，格式为：yyyy-MM-dd，例如：2021-04-07 |
| end | false | String | 结束日期，格式为：yyyy-MM-dd，例如：2021-04-10 |
### 示例
```requestUrl
http://api.polyv.net/v2/geo/1b448be323?start=2021-03-16&sign=DD025D6491BDBB57D3646AE23F19821A065BA2C5&end=2021-03-24&userId=1b448be323&ptime=1617875694840&dr=7days
```
### 响应参数描述
| 参数名 | 类型 | 说明 |
| ------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| 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_geo_stat.md?id=polyv1)】，响应失败时返回空 |
[**Data参数描述**](#/vod/api/statistics/get_geo_stat.md?id=polyv1)
| 字段 | 类型 | 说明 |
| ------------------------ | ------- | --------------------------------- |
| province | String | 省份 |
| pcPlayDuration | Integer | pc端播放时长，单位为秒 |
| formatPcPlayDuration | String | 格式化的pc端播放时长，格式为：时:分:秒，例如：00:00:00 |
| pcFlowSize | Long | pc端消耗流量，单位字节 |
| pcVideoView | Integer | pc端播放量 |
| pcUniqueViewer | Integer | pc端观众量 |
| mobilePlayDuration | Integer | 移动端播放时长，单位为秒 |
| formatMobilePlayDuration | String | 移动端格式化播放时长，格式为：时:分:秒，例如：00:00:00 |
| mobileFlowSize | Long | 移动端消耗流量，单位字节 |
| mobileVideoView | Integer | 移动端播放量 |
| mobileUniqueViewer | Integer | 移动端观众量 |
### 返回错误代码列表
| 错误代码 | 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. | 后台程序抛异常 |
### 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(VodVideoAdvertising.class);
/**
* 查询视频播放的地理位置分布
*/
@Test
public void testGetGeoStat() throws Exception, NoSuchAlgorithmException {
//公共参数,填写自己的实际参数
String secretKey = super.secretKey;
String userId = super.userId;
String ptime = String.valueOf(System.currentTimeMillis());
//业务参数
String url = String.format("http://api.polyv.net/v2/geo/%s", userId);
String dr = "7days";
String start = "2021-03-16";
String end = "2021-03-24";
Map requestMap = new HashMap<>();
requestMap.put("userId", userId);
requestMap.put("ptime", ptime);
requestMap.put("dr", dr);
requestMap.put("start", start);
requestMap.put("end", end);
requestMap.put("sign", VodSignUtil.getSign(requestMap, secretKey));
String response = HttpUtil.get(url, requestMap);
log.debug("测试查询视频播放的地理位置分布,{}", 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": [{
"province": "湖南",
"pcPlayDuration": 190,
"formatPcPlayDuration": "00:03:10",
"pcFlowSize": 44231209,
"pcVideoView": 17,
"pcUniqueViewer": 4,
"mobilePlayDuration": 57,
"formatMobilePlayDuration": "00:00:57",
"mobileFlowSize": 14242541,
"mobileVideoView": 4,
"mobileUniqueViewer": 3
}]
}
```
异常示例
```json
{
"code": 400,
"status": "error",
"message": "ptime is too old.",
"data": ""
}
```