訂閱列表
更新時間 2024-12-05 17:31:14
最近更新時間: 2024-12-05 17:31:14
分享文章
接口功能介紹
查看報表訂閱列表
接口約束
傳參規范
URI
GET /vfw/v2_report_subscribe
路徑參數
無
Query參數
無
請求參數
請求頭header參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| urlType | 是 | String | 請求地址類型 | CTAPI | |
| regionId | 是 | String | 資源池id | 100054c0416811e9a6690242ac110002 |
請求體body參數
無
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | String | 狀態碼 | ||
| message | String | 返回信息 | 成功 | |
| error | String | 錯誤碼：CFW_0000 :成功!;CFW_0001:參數錯誤！;CFW_0002：業務錯誤！ | CFW_0000 | |
| returnObj | Object | 接口返回結果 | ReportSubscribeView |
表 ReportSubscribeView
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| reportType | Array of Strings | 報表類型 | ["DAY"] | |
| subscriberCount | Integer | 訂閱人數 | 1 | |
| users | Array of Objects | 報表類型 | User |
表 User
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| loginEmail | String | 用戶登錄郵箱 | 844*@qq.com | |
| accountId | String | 賬戶id | e974b0438b814fc08ec8e499643e530f | |
| lastNoticedTime | String | 上一次發送時間 | 2024-10-24T16:00:24Z | |
| userId | String | 用戶id | 913d6b7d9a1b46769af6c1de79046a06 | |
| userName | String | 用戶名稱 | 8*61 | |
| selected | String | 是否被選中 | 1 |
枚舉參數
無
請求示例
請求url
無
請求頭header
{
"regionid": "100054c0416811e9a6690242ac110002",
"urlType": "CTAPI"
}
請求體body
{}
響應示例
{
"statusCode": "800",
"error": "CFW_0000",
"message": "成功!",
"returnObj": {
"reportType": [
"",
"WEEK",
"DAY",
"MONTH"
],
"subscriberCount": 2,
"users": [
{
"loginEmail": "844*@qq.com",
"accountId": "e974b0438b814fc08ec8e499643e530f",
"lastNoticedTime": "2024-10-24T16:00:24Z",
"userName": "8*61",
"userId": "913d6b7d9a1b46769af6c1de79046a06",
"selected": 1
}
]
}
}
狀態碼
請參考
錯誤碼
請參考
