查詢子帳號統計詳情
更新時間:2022-09-02 18:08:07
介面描述
1、按日期查询子账号统计详情列表
2、接口userid为点播账号userid,具体参考菜单【使用须知】->【获取密钥】
3、接口支持https协议
介面URL
https://api.polyv.net/v2/sub-account/stats/detail/list
請求方式
POST
介面限制
1、介面同時支援HTTP、HTTPS,建議使用HTTPS以確保介面安全,介面呼叫有頻率限制,詳細請查看
2、email、appId 必傳其中一個,若同時傳了email和appId,則優先使用email
請求參數描述
| 參數名 | 必選 | 類型 | 說明 |
|---|---|---|---|
| userid | true | String | 保利威點播帳戶id,可參考【取得密鑰】取得,取得路徑:官網->登入->點播(開發設定) |
| ptime | true | Long | 當前時間的毫秒級時間戳,3分鐘內有效 |
| sign | true | String | 簽名,為40位大寫的SHA1值【詳見簽名生成規則】 |
| startDate | true | String | 開始日期,格式為:yyyy-MM-dd,例如:2021-04-07,時間跨度不能超過一年 |
| endDate | true | String | 結束日期,格式為:yyyy-MM-dd,例如:2021-04-10,時間跨度不能超過一年 |
| false | String | 要查詢的子帳號信箱,若同時傳了email和appId,則優先使用email | |
| appId | false | String | 要查詢的子帳號appId |
範例
https://api.polyv.net/v2/sub-account/stats/detail/list
表單參數:
sign=25B8ED6CD0AF4E0058D44DA5D395A569701328F9&ptime=1623056999195&userid=cca90d24f7&startDate=2021-05-01&endDate=2021-06-01
響應參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| code | Integer | 響應狀態碼,200為成功返回,非200為失敗【詳見全域錯誤說明】 |
| status | String | 響應狀態文字資訊 |
| message | String | 響應描述資訊,當code為400或500時,輔助描述錯誤原因 |
| data | Object | 響應成功時返回子帳號每天的詳情資料列表【詳見data欄位說明】 |
data參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| details | Array | 子帳號每天的詳情資料列表,當一天沒有資料時,相關資料為0【詳見details欄位說明】 |
details欄位說明
| 欄位 | 類型 | 說明 |
|---|---|---|
| currentDay | String | 日期,格式:yyyy-MM-dd,如:2021-06-01 |
| pcFlowSize | Long | PC端播放流量,單位:byte |
| mobileFlowSize | Long | 行動端播放流量,單位:byte |
| totalFlowSize | Long | 總流量,單位:byte |
| pcView | Long | PC端播放量,單位:個 |
| mobileView | Long | 行動端播放量,單位:個 |
| totalView | Long | 總播放量,單位:個 |
| pcDuration | Long | PC端播放時長,單位:秒 |
| mobileDuration | Long | 行動端播放時長,單位:秒 |
| totalDuration | Long | 總播放時長,單位:秒 |
Java請求範例
快速接入基礎代碼請下載相關依賴原始碼, 點擊下載原始碼 ,下載後加入到自己的原始碼工程中即可。測試用例中的HttpUtil.java 和 VodSignUtil.java 都包含在下載檔案中。
強烈建議您使用點播Java SDK完成API的功能對接,點播Java SDK 對API呼叫邏輯、異常處理、資料簽名、HTTP請求執行緒池進行了統一封裝和最佳化。能大大提高B端的接入速度和便捷性;
/**
* 子账号详情数据列表
* @throws Exception
*/
@Test
public void testGetSubAccountDetailList() throws Exception {
//公共参数,填写自己的实际参数
String secretKey = super.secretKey;
String userId = super.userId;
String ptime = String.valueOf(System.currentTimeMillis());
//业务参数
String url = "https://api.polyv.net/v2/sub-account/stats/detail/list";
String startDate="2021-05-01";
String endDate="2021-06-01";
String email="xxx@polyv.net";
String appId="xxxxxxxx";
Map<String, String> requestMap = new HashMap<>();
requestMap.put("userId", userId);
requestMap.put("ptime", ptime);
requestMap.put("startDate", startDate);
requestMap.put("endDate", endDate);
requestMap.put("email", email);
requestMap.put("appId", appId);
requestMap.put("sign", VodSignUtil.getSign(requestMap, secretKey));
String response = HttpUtil.postFormBody(url, requestMap);
//do somethings
}
響應範例
系統全域錯誤說明詳見全域錯誤說明
成功範例
{
"code": 200,
"status": "success",
"message": "success",
"data": {
"details": [
{
"currentDay": "2021-06-01",
"pcFlowSize": 0,
"mobileFlowSize": 0,
"totalFlowSize": 0,
"pcView": 0,
"mobileView": 0,
"totalView": 0,
"pcDuration": 0,
"mobileDuration": 0,
"totalDuration": 0
}
]
}
}
異常範例
{
"code":400,
"status":"error",
"message":"sign can not be empty.",
"data":""
}
