Documentation
Table of Contents
Reportオブジェクト
次のオブジェクトは、reportAPIに直接関連しています。
Report
report オブジェクトは以下のプロパティを持ちます。
| プロパティ | タイプ | 説明 |
|---|---|---|
| reportid | string | (読取専用) レポートのID |
| userid (必須) |
string | レポートを作成したユーザーのID |
| name (必須) |
string | ユニークなレポート名 |
| dashboardid (必須) |
string | レポートの基になっているダッシュボードのID |
| period | integer | レポートが作成される期間 使用可能な値： 0 - (デフォルト)前日 1 - 前週 2 - 前月 3 - 前年 |
| cycle | integer | 期間の繰り返しスケジュール 使用可能な値： 0 - (デフォルト)毎日 1 - 毎週 2 - 毎月 3 - 毎年 |
| start_time | integer | レポートの送信準備が行われる時刻（秒単位） デフォルト：0 |
| weekdays | integer | レポートを送信する曜日 週次レポートにのみ必要 曜日はバイナリ形式で保存され、各ビットは対応する曜日を表します。 たとえば12はバイナリで1100に等しく、レポートが毎週水曜日と木曜日に送信されることを意味します。 |
| 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
users オブジェクトには次のプロパティがあります。
| プロパティ | タイプ | 説明 |
|---|---|---|
| userid (必須) |
string | レポート送信先のユーザーID |
| access_userid | string | レポートが生成されるユーザーID 0 - (デフォルト)受信者ごとにレポートを生成 |
| exclude | integer | ユーザーをメーリングリストから除外するか 可能な値： 0 - (デフォルト)含める 1 - 除外する |
User groups
user groups オブジェクトには次のプロパティがあります。
| プロパティ | タイプ | 説明 |
|---|---|---|
| usrgrpid (必須) |
string | レポート送信先のユーザーグループID |
| access_userid | string | レポートが生成されるユーザーID。 0 - (デフォルト)受信者ごとにレポートを生成 |