Table of Contents
> 报告 object
以下objects与report API直接相关。
报告
报告 object 具有以下属性:
| 属性 | 数据类型 | 描述 |
|---|---|---|
| reportid | string | (只读) 报告的ID. |
| userid (required) |
string | 创建报告的用户ID. |
| name (required) |
string | 报告的唯一名称. |
| dashboardid (required) |
string | 报告所基于的仪表板ID. |
| period | integer | 报告准备的时间段. 可能的值: 0 - (默认) 前一天; 1 - 前一周; 2 - 前一个月; 3 - 前一年. |
| cycle | integer | 报告重复的时间计划. 可能的值: 0 - (默认) 每天; 1 - 每周; 2 - 每月; 3 - 每年. |
| start_time | integer | 一天中准备发送报告的时间,以秒为单位. 默认: 0. |
| weekdays | integer | 发送报告的星期几. 仅对每周报告是必需的. 可能的位图值: 1 - 星期一; 2 - 星期二; 4 - 星期三; 8 - 星期四; 16 - 星期五; 32 - 星期六; 64 - 星期日. 这是一个位掩码字段;可以接受任何可能的位图值的总和(例如,21表示星期一、星期三和星期五). 默认: 0. |
| active_since | string | 从哪个日期开始. 可能的值: 空 string - (默认) 未指定(存储为0); YYYY-MM-DD格式的具体日期(存储为一天开始的时间戳(00:00:00)). |
| active_till | string | 到哪个日期结束. 可能的值: 空 string - (默认) 未指定(存储为0); YYYY-MM-DD格式的具体日期(存储为一天结束的时间戳(23:59:59)). |
| subject | string | 报告消息的主题. |
| message | string | 报告消息的文本. |
| status | integer | 报告是否启用或禁用. 可能的值: 0 - 禁用; 1 - (默认) 启用. |
| description | text | 报告的描述. |
| state | integer | (只读) 报告的状态. 可能的值: 0 - (默认) 报告尚未处理; 1 - 报告已生成并成功发送给所有收件人; 2 - 报告生成失败;"info"包含错误信息; 3 - 报告已生成,但发送给部分(或全部)收件人失败;"info"包含错误信息. |
| lastsent | timestamp | (只读) 上次成功发送报告的Unix时间戳. |
| info | string | (只读) 错误描述或附加信息. |
请注意,对于某些方法(update, delete),必需/可选参数的组合是不同的.
用户
用户object具有以下属性：
| 属性 | 数据类型 | 描述 |
|---|---|---|
| userid (required) |
string | 接收报告的用户ID |
| access_userid | string | 代表生成报告的用户ID 0 - (默认) 由接收者生成报告 |
| exclude | integer | 是否从邮件列表中排除该用户 可选值： 0 - (默认) 包含； 1 - 排除 |
用户组
用户组 object 具有以下属性：
| 属性 | 数据类型 | 描述 |
|---|---|---|
| usrgrpid (required) |
string | 接收报告的用户组ID |
| access_userid | string | 生成报告所代表的用户ID 0 - (默认) 由接收者生成报告 |