MailTrafficSummary レポート
MailTrafficSummary REST URI は、組織の Office 365 電子メール システムを通して処理されたメッセージに関するさまざまなカテゴリの概要リストを提供します。レポートの開始日時と終了日時は、データの集計期間として要求内で指定できます。このレポートは、汎用的な名前が付いた 20 のフィールドを返します。これらのフィールド内のデータは他のオプションに基づいて変更できます。
最終更新日: 2015年9月17日
適用対象: Office 365
REST URI
https://reports.office365.com/ecp/reportingwebservice/reporting.svc/MailTrafficTop[?ODATA options]
フィールド
次のフィールドは、$select、$filter、$orderby ODATA2 クエリ オプションに指定できます。$select オプションが指定されない場合、すべてのフィールドが返されます。
名前 |
WCF 型* |
EDM 型* |
[入力/出力]** 説明 |
値の例 |
提供されたバージョン |
---|---|---|---|---|---|
C1 ~ C20 |
通常は string |
通常は指定なし |
[入力/出力] このフィールド内のデータの意味は変化します。「解説」セクション内の定義を参照してください。 |
userone@example.onmicrosoft.com |
2013-V1 |
Category |
string |
指定なし |
[入力] 要求された概要レポートのタイプです。$filter オプション内のこのフィールドの設定によって、C1-C20 フィールドの意味が決まります。詳細については、「解説」セクションを参照してください。 |
OutboundHits、TopMailSender、TopMalware など |
2013-V1 |
DlpPolicy |
string |
指定なし |
[入力/出力] メッセージに適用された DLP ポリシーの名前です。有効な DlpPolicy 値の詳細については、「MailFilterList レポート」を参照してください。 |
Financial Data Detection、HIPAA Detection、PII Detection |
2013-V1 |
Domain |
string |
指定なし |
[入力/出力] 電子メールを処理した完全修飾ドメイン名です。 |
example.onmicrosoft.com |
2013-V1 |
EndDate |
System.DateTime |
Edm.DateTime |
[入力] このフィールドは、レポート期間を制限するのに使用されます。 このフィールドを $filter クエリ オプションに使用して、レポート期間の終了日時を設定します。EndDate を $filter オプションに指定した場合、StartDate も指定する必要があります。 |
短い形式の日付 (たとえば、03/10/2013) または引用符付きの日付/時刻 (たとえば、"03/10/2013 4:55 PM") |
2013-V1 |
StartDate |
System.DateTime |
Edm.DateTime |
[入力] このフィールドは、レポート期間を制限するのに使用されます。 このフィールドを $filter クエリ オプションに使用して、レポート期間の開始日時を設定します。StartDate を $filter オプションに指定した場合、EndDate も指定する必要があります。 |
短い形式の日付 (たとえば、03/10/2013) または引用符付きの日付/時刻 (たとえば、"03/10/2013 4:55 PM") |
2013-V1 |
TransportRule |
string |
指定なし |
処理ステップで実行される Microsoft Exchange トランスポート ルールの名前です。有効な TransportRule 値の詳細については、「MailFilterList レポート」を参照してください。 |
PII Detection |
2013-V1 |
*WCF 型 は、Visual Studio で Windows Communication Foundation (WCF) サービス参照が作成されたときにフィールドに割り当てられる .NET Framework データ型を参照します。EDM 型は、Atom 形式のレポートで返される ADO.NET エンティティ データ モデル (EDM) 型を参照します。
**[入力/出力] インジケータについては、「入力パラメーターとレポート出力列」のセクションを参照してください。
解説
レポート内の各エントリにはメタデータの複数のフィールドが含まれます。 詳しくは、「Office 365 レポート Web サービスが返す一般的なメタデータ」を参照してください。
Date フィールドは、メッセージが Office 365 システムで処理された日時を示し、それらのサーバーのタイム ゾーンで報告されます。
ODATA $orderby オプションはこのレポートでは機能しません。
StartDate と EndDate の使用
StartDate と EndDate フィールドは、レポート結果では有用な情報を提供しませんし、レポート出力では常に 0001-01-01T00:00:00Z に設定されます。これらは、レポート時間ウィンドウで簡単に制限を行えるようにするためのもので、「日次」のレポートよりも細かく時間指定できるようにします。
これは、たとえば、電子メールベースのサービス拒否攻撃を時間単位で記録するときに特に役立ちます。これらのフィールドを使用する際、両方とも $filter オプションに含める必要があります。どちらもオプションですが、一方を指定した場合、もう一方も指定する必要があります。StartDate/EndDate のペアがクエリに指定されていない場合、既定のレポート期間は、前の 2 週間になります。このトピックの後ろにある「サンプル」セクションで、StartDate フィールドと EndDate フィールドの使用方法について示します。
カテゴリと Cn フィールド定義
汎用的な名前が付けられた C1 ~ C20 フィールドは、Category に指定された値に基づいて変化します。カテゴリを指定するには、次の例のように、$filter オプションに照合式を追加します。
$filter=Category eq 'TopMailRecipient'
以下に、Category フィールドに指定できる値と返される情報のタイプを示します。
InboundDLPHits は、指定されたデータ損失防止 (DLP) ポリシー アクションが受信メッセージのレポート期間にトリガーされた回数の順序付きリストを返します。
InboundDLPPolicyRuleHits は、指定された DLP ポリシー ルール アクションが受信メッセージのレポート期間にトリガーされた回数の順序付きリストを返します。
InboundTransportRuleHits は、指定されたトランスポート ルール アクションが受信メッセージのレポート期間にトリガーされた回数の順序付きリストを返します。
OutboundDLPHits は、指定されたデータ漏洩防止 (DLP) ポリシー アクションが送信メッセージのレポート期間にトリガーされた回数の順序付きリストを返します。
OutboundDLPPolicyRuleHits は、指定された DLP ポリシー ルール アクションが送信メッセージのレポート期間にトリガーされた回数の順序付きリストを返します。
OutboundTransportRuleHits は、指定されたトランスポート ルール アクションが送信メッセージのレポート期間にトリガーされた回数の順序付きリストを返します。
TopMailSender は、レポート期間に最も多くの電子メールを送信したユーザーの順序付きリストを返します。
TopMailRecipient は、レポート期間に最も多くの電子メールを受信したユーザーの順序付きリストを返します。
TopMalware は、レポート期間に検出されたマルウェアの順序付きリストを返します。
TopMalwareRecipient は、レポート期間にマルウェアを含む最も多くのメッセージを受信したユーザーの順序付きリストを返します。
TopSpamRecipient は、レポート期間にスパムを含む最も多くのメッセージを受信したユーザーの順序付きリストを返します。
下の表は、カテゴリ値とその結果としての Cn フィールドの定義を示しています。この表には情報を含む列だけが表示されています。レポート内のデータを含まない列は null 値になります。列に返される値の多くは MailFilterList レポートによって返されるリストにも表示されます。$filter 式を使用して特定の DLP ポリシー、DLP ルール、またはトランスポート ルールを照合する場合は、MailFilterList レポートに返された値を使用して正確な一致を確認します。
C4 ~ C20 フィールドは現在使用されておらず、将来の拡張用として予約されています。
カテゴリ |
値が設定される列 |
例 |
---|---|---|
InboundDLPHits |
C1: [string] データ損失防止 (DLP) ルールの名前。 |
<d:C1>PII Detection</d:C1> |
InboundDLPPolicyRuleHits |
C1: [string] DLP ポリシー名。 |
<d:C1>PII Detection</d:C1> |
InboundTransportRuleHits |
C1: [string] トランスポート ルール名。 |
<d:C1>PII Detection</d:C1> |
OutboundDLPHits |
C1: [string] DLP ルール名。 |
<d:C1>PII Detection</d:C1> |
OutboundDLPPolicyRuleHits |
C1: [string] DLP ポリシー名。 |
<d:C1>PII Detection</d:C1> |
OutboundTransportRuleHits |
C1: [string] トランスポート ルール。 |
<d:C1>PII Detection</d:C1> |
TopMailSender |
C1: [string] レポート期間に最多の電子メールを送信したユーザーの SMTP 電子メール アドレス。 |
<d:C1>userone@example.onmicrosoft.com</C1> |
TopMailRecipient |
C1: [string] レポート期間に最多の電子メールを受信したユーザーの SMTP 電子メール アドレス。 |
<d:C1>usertwo@example.onmicrosoft.com</C1> |
TopMalware |
C1: [string] レポート期間に最も頻繁に受信されたマルウェアの名前。 |
<d:C1>dos/eicar_test_file</d:C1> |
TopMalwareRecipient |
C1: [string] レポート期間にマルウェアを含む最多のメッセージを受信したユーザーの SMTP 電子メール アドレス。 |
<d:C1>usertwo@example.onmicrosoft.com</C1> |
TopSpamRecipient |
C1: [string] レポート期間にスパムを含む最多のメッセージを受信したユーザーの SMTP 電子メール アドレス。 |
<d:C1>usertwo@example.onmicrosoft.com</C1> |
例
下の例では、2012 年の最後の 3 か月間の上位 2 名の電子メール受信者を要求します。見やすくするために、要求と応答の両方に改行が追加されています。
https://reports.office365.com/ecp/reportingwebservice/reporting.svc/MailTrafficSummary?
$select=C1,C2,C3&
$filter=Category%20eq%20'TopMailRecipient'%20and%20
StartDate%20eq%20datetime'2012-10-01T00:00:00Z'%20and%20
EndDate%20eq%20datetime'2013-12-31T23:59:59Z'&
$top=2&
$format=Atom
<?xml version="1.0" encoding="utf-8"?>
<feed xml:base="https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/"
xmlns="http://www.w3.org/2005/Atom"
xmlns:d="https://schemas.microsoft.com/ado/2007/08/dataservices"
xmlns:m="https://schemas.microsoft.com/ado/2007/08/dataservices/metadata">
<id>https://reports.office365.com/ecp/reportingwebservice/reporting.svc/MailTrafficSummary</id>
<title type="text">MailTrafficSummary</title>
<updated>2013-02-09T20:06:36Z</updated>
<link rel="self" title="MailTrafficSummary" href="MailTrafficSummary" />
<entry>
<id>https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTrafficSummary(0)</id>
<category term="TenantReporting.MailTrafficSummaryReport"
scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
<link rel="edit" title="MailTrafficSummaryReport" href="MailTrafficSummary(0)" />
<title />
<updated>2013-02-09T20:06:36Z</updated>
<author>
<name />
</author>
<content type="application/xml">
<m:properties>
<d:C1>userone@example.onmicrosoft.com</d:C1>
<d:C2>3185</d:C2>
<d:C3 m:null="true" />
</m:properties>
</content>
</entry>
<entry>
<id>https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTrafficSummary(0)</id>
<category term="TenantReporting.MailTrafficSummaryReport"
scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
<link rel="edit" title="MailTrafficSummaryReport" href="MailTrafficSummary(0)" />
<title />
<updated>2013-02-09T20:06:36Z</updated>
<author>
<name />
</author>
<content type="application/xml">
<m:properties>
<d:C1>usertwo@example.onmicrosoft.com</d:C1>
<d:C2>352</d:C2>
<d:C3 m:null="true" />
</m:properties>
</content>
</entry>
</feed>
以下に、同じ結果を JSON 形式で示します。
{
"d":
[
{
"__metadata":
{
"id":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTrafficSummary(0)",
"uri":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTrafficSummary(0)",
"type":"TenantReporting.MailTrafficSummaryReport"
},
"C1":"userone@example.onmicrosoft.com",
"C2":"3185",
"C3":null
},
{
"__metadata":
{
"id":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTrafficSummary(0)",
"uri":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/MailTrafficSummary(0)",
"type":"TenantReporting.MailTrafficSummaryReport"
},
"C1":"usetwo@example.onmicrosoft.com",
"C2":"352",
"C3":null
}
]
}
入力パラメーターとレポート出力列
フィールド表の [入力/出力] という表記には次の意味があります。
フィールド表で [入力] が付いているフィールドは、主に $filter=、$orderby= およびレポートが返すエントリを制限する他のクエリ オプションで使用するためのものです。フィールド表で [入力] が付いているフィールドは、$select= オプションに含めることができ、レポート エントリに表示されますが、有用なデータは入っていません。
フィールド表で [入力/出力] が付いているフィールドは、列選択 ($select=) およびエントリ制限 ($filter= と $orderby=) オプションの両方で使用できます。これらのフィールドを $select= オプションに含めると、レポート エントリに表示され、利用可能な場合には有用なデータが入っています。
互換性
MailTrafficSummary レポートは Office 365 サービス バージョン 2013-V1 で導入されました。バージョン管理の詳細については、「Office 365 レポート Web サービスのバージョン管理」を参照してください。
対応する Windows PowerShell コマンドレット
MailTrafficTop レポートは、Get-MailTrafficSummaryReport Windows PowerShell コマンドレットと同じ情報を返します。
権限
レポートにアクセスするアカウントには、その Office 365 組織の管理権限が必要です。このレポートを Office 365 コントロール パネルで表示できる場合、そのアカウントには REST Web サービスからデータを取得する権限があります。 このレポートでは、ユーザーを参照のみ可受信者の役割に割り当てる必要があります。 既定の Office 365 権限構造では、次の管理者権限があるユーザーはこのレポートにアクセスできます: 課金管理者、全体管理者、パスワード管理者、サービス管理者、ユーザー管理の管理者。詳しくは、「MailboxUsage レポート」を参照してください。
データの細分性、永続性、可用性
このレポートで入手可能な情報は、各イベントの正確な日付と時刻と一緒に保存されます。$filter オプションに StartDate フィールドと EndDate フィールドを含めることによって、実現可能な期間を指定できます。時刻は電子メールをスキャンするサーバーのタイム ゾーンで報告されます。
このレポートの情報は、14 日間またはサブスクリプションをキャンセルするまで利用可能です。
イベントがレポートに表示されるまで、最大で 24 時間遅れる場合があります。