Table of Contents

报告对象

接下来介绍有关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 发送报表的星期几。

星期几以二进制形式存储,每个位代表相应的星期几。例如,12 等于二进制的 1100,表示每周三和周四发送报表。

默认值: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”包含错误信息。

属性行为:
- read-only
lastsent timestamp 上次成功发送报表的 Unix 时间戳。

属性行为:
- read-only
info string 错误描述或其他信息。

属性行为:
- read-only

用户

用户对象包含了以下属性:

属性 类型 描述
userid ID 接收报告的用户ID。

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

0 - (默认) 按照接收人生成报告。
exclude integer 是否从邮件列表中排除用户。

可选值:
0 - (默认) 包含;
1 - 不包含.

用户组

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

属性 类型 说明
usrgrpid ID 要向其发送报表的用户组的 ID。

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

0 - (默认) 按收件人生成报表。