Table of Contents
> 报告 object
以下objects与report API直接相关。
报告
报告object具有以下属性：
| 属性 | 数据类型 | 描述 |
|---|---|---|
| reportid | string | (只读) 报告的ID。 |
| userid (required) |
string | 创建报告的用户ID。 |
| name (required) |
string | 报告的唯一名称。 |
| dashboardid (required) |
string | 报告所基于的仪表板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。 |
| 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 (required) |
string | 接收报告的用户ID |
| access_userid | string | 代表生成报告的用户ID 0 - (默认) 由收件人生成报告 |
| exclude | integer | 是否从邮件列表中排除该用户 可选值： 0 - (默认) 包含； 1 - 排除 |
用户组
用户组 object 具有以下属性：
| 属性 | 数据类型 | 描述 |
|---|---|---|
| usrgrpid (required) |
string | 接收报告的用户组ID。 |
| access_userid | string | 代表生成报告的用户ID。 0 - (默认) 由接收者生成报告。 |