以下 objects 直接与 report
API 相关。
报告 object 具有以下属性:
属性 | 数据类型 | 描述 |
---|---|---|
reportid | ID | 报告的 ID。 属性行为: - 只读 - 在 update 操作中必填 |
userid | ID | 创建报告的用户的 ID。 属性行为: - 在 create 操作中必填 |
name | string | 报告的唯一名称。 属性行为: - 在 create 操作中必填 |
dashboardid | ID | 报告所基于的仪表板的 ID。 属性行为: - 在 create 操作中必填 |
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 | 从哪一天开始。 可能的值: 空 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 | 错误描述或附加信息。 属性行为: - 只读 |
用户 object 具有以下属性:
属性 | 数据类型 | 描述 |
---|---|---|
userid | ID | 接收报表用户的ID。 属性行为: - 必填 |
access_userid | ID | 以哪个用户身份生成报表。 0 - (默认) 按接收者生成报表。 |
exclude | integer | 是否从邮件列表中排除该用户。 可能的值: 0 - (默认) 包含; 1 - 排除。 |
用户组 object 具有以下属性: