报告对象

接下来介绍有关report(报告) API 的相关内容。

报告

报告对象具有以下属性:

Property Type Description
reportid ID 报告的 ID。

属性行为:
- 只读
- 更新操作时必需
userid ID 创建报告的用户的 ID。

属性行为:
- 创建操作时必需
name string 报告的唯一名称。

属性行为:
- 创建操作时必需
dashboardid ID 报告所基于的仪表板的 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。

属性行为:
- 当 cycle 设置为 "weekly" 时必需。
active_since string 开始日期。

可能的值:
空字符串 - (默认)未指定(存储为 0);
YYYY-MM-DD 格式的具体日期(存储为当天开始时间(00:00:00)的时间戳)。
active_till 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 错误描述或其他信息。

属性行为:
- 只读

用户

users 对象具有以下属性:

属性 类型 描述
userid ID 要向其发送报告的用户 ID。

属性行为:
- 必填
access_userid ID 将以其名义生成报告的用户 ID。

0 - (默认) 由收件人生成报告。
exclude integer 是否将该用户排除在邮件列表之外。

可能的值:
0 - (默认) 包含;
1 - 排除。

用户组

用户组对象具有以下属性:

属性 Type 描述
usrgrpid ID 要将报告发送到的用户组 ID。

属性行为:
- 必填
access_userid ID 将代表其生成报告的用户 ID。

0 - (默认) 由收件人生成报告。