接口功能介绍
查看报表订阅列表
接口约束
传参规范
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
}
]
}
}
状态码
请参考 状态码
错误码
请参考 错误码
