报告对象

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

报表

报表对象具有以下属性:

属性 类型 描述
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 - (默认) 由收件人生成报告。