报告 object

以下 objects 直接与 report API 相关。

报告

report 对象具有以下属性：

Property Type Description
reportid ID 报告的 ID。

Property behavior:
- read-only
- required for update operations
userid ID 创建该报告的用户 ID。

Property behavior:
- required for create operations
name string 报告的唯一名称。

Property behavior:
- required for create operations
dashboardid ID 报告所基于的仪表板 ID。

Property behavior:
- required for create operations
period integer 将为其生成报告的周期。

Possible values:
0 - (default) previous day;
1 - previous week;
2 - previous month;
3 - previous year.
cycle integer 周期重复计划。

Possible values:
0 - (default) daily;
1 - weekly;
2 - monthly;
3 - yearly.
start_time integer 一天中的时间，以秒为单位，报告将在该时间准备发送。

Default: 0.
weekdays integer 发送报告的星期几。

Possible bitmap values:
1 - Monday;
2 - Tuesday;
4 - Wednesday;
8 - Thursday;
16 - Friday;
32 - Saturday;
64 - Sunday.

This is a bitmask field; any sum of possible bitmap values is acceptable (for example, 21 for Monday, Wednesday, and Friday).

Default: 0.

Property behavior:
- required if cycle is set to "weekly".
active_since string 开始日期。

Possible values:
empty string - (default) not specified (stored as 0);
specific date in YYYY-MM-DD format (stored as a timestamp of the beginning of a day (00:00:00)).
active_till string 结束日期。

Possible values:
empty string - (default) not specified (stored as 0);
specific date in YYYY-MM-DD format (stored as a timestamp of the end of a day (23:59:59)).
subject string 报告消息主题。
message string 报告消息文本。
status integer 报告是启用还是禁用。

Possible values:
0 - Disabled;
1 - (default) Enabled.
description text 报告的描述。
state integer 报告的状态。

Possible values:
0 - (default) report was not yet processed;
1 - report was generated and successfully sent to all recipients;
2 - report generating failed; "info" contains error information;
3 - report was generated, but sending to some (or all) recipients failed; "info" contains error information.

Property behavior:
- read-only
lastsent timestamp 最后一次成功发送的报告的 Unix 时间戳。

Property behavior:
- read-only
info string 错误描述或附加信息。

Property behavior:
- read-only

用户

users 对象具有以下属性：

Property Type Description
userid ID 要向其发送报告的用户 ID。

属性行为：
- required
access_userid ID 用于生成报告的用户 ID。

0 - (default) 由接收者生成报告。
exclude integer 是否将该用户从邮件列表中排除。

可能的值：
0 - (default) 包含；
1 - 排除。

用户组

user groups 对象具有以下属性：

Property Type Description
usrgrpid ID 要向其发送报告的用户组 ID。

属性行为:
- required
access_userid ID 用于生成报告的用户 ID。

0 - (default) 由接收者生成报告。