Get-MailTrafficPolicyReport
Applies to: Exchange Online, Exchange Online Protection
This cmdlet is available only in the cloud-based service.
Use the Get-MailTrafficPolicyReport cmdlet to view statistics about messages that were affected by data loss prevention (DLP) policies and transport rules.
For information about the parameter sets in the Syntax section below, see Syntax.
Get-MailTrafficPolicyReport [-Action <MultiValuedProperty>] [-AggregateBy <String>] [-Direction <MultiValuedProperty>] [-DlpPolicy <MultiValuedProperty>] [-Domain <MultiValuedProperty>] [-EndDate <DateTime>] [-EventType <MultiValuedProperty>] [-Expression <Expression>] [-Page <Int32>] [-PageSize <Int32>] [-ProbeTag <String>] [-StartDate <DateTime>] [-SummarizeBy <MultiValuedProperty>] [-TransportRule <MultiValuedProperty>]
This example retrieves the statics for outgoing messages between June 13, 2015 and June 15, 2015 that were affected by DLP policies and transport rules.
Get-MailTrafficPolicyReport -Direction Outbound -StartDate 06/13/2015 -EndDate 06/15/2015
This example retrieves the statics for outgoing messages on December 12, 2015, and displays the results in a table. Every unique combination of EventType and Action is displayed on a separate row in the table.
Get-MailTrafficPolicyReport -StartDate 12/12/2015 -EndDate 12/12/2015 -Direction Outbound | Format-Table Domain,Date,EventType,Action,MessageCount
This example is similar to the previous example, but now the results are summarized. Because the EventType is one of the summarized values, the rows in the table now contain the unique values of Action. The total number of rows in the report is reduced, and values of MessageCount are correspondingly larger on each row.
Get-MailTrafficPolicyReport -StartDate 12/12/2015 -EndDate 12/12/2015 -Direction Outbound -SummarizeBy Domain,DlpPolicy,TransportRule,EventType | Format-Table Domain,Date,EventType,Action,MessageCount
You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "View reports" entry in the Feature permissions in Exchange Online topic.
| Parameter | Required | Type | Description |
|---|---|---|---|
| Action | Optional | Microsoft.Exchange.Data.MultiValuedProperty | The Action parameter filters the report by the action taken by DLP policies, transport rules, malware filtering, or spam filtering. To view the complete list of valid values for this parameter, run the command You can specify multiple values separated by commas. |
| AggregateBy | Optional | System.String |
The AggregateBy parameter specifies the reporting period. Valid values are |
| Direction | Optional | Microsoft.Exchange.Data.MultiValuedProperty |
The Direction parameter filters the results by incoming or outgoing messages. Valid values for this parameter are |
| DlpPolicy | Optional | Microsoft.Exchange.Data.MultiValuedProperty | The DlpPolicy parameter filters the report by the name of the DLP policy. You can specify multiple values separated by commas. If the value contains spaces, enclose the value in quotation marks ("). |
| Domain | Optional | Microsoft.Exchange.Data.MultiValuedProperty |
The Domain parameter filters the results by an accepted domain in the cloud-based organization. You can specify multiple domain values separated by commas, or the value |
| EndDate | Optional | System.DateTime | The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2015 to specify September 1, 2015. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2015 5:00 PM". |
| EventType | Optional | Microsoft.Exchange.Data.MultiValuedProperty | The EventType parameter filters the report by the event type. To view the complete list of valid values for this parameter, run the command You can specify multiple values separated by commas. |
| Expression | Optional | System.Linq.Expressions.Expression | This parameter is reserved for internal Microsoft use. |
| Page | Optional | System.Int32 | The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. |
| PageSize | Optional | System.Int32 | The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. |
| ProbeTag | Optional | System.String | This parameter is reserved for internal Microsoft use. |
| StartDate | Optional | System.DateTime | The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2015 to specify September 1, 2015. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2015 5:00 PM". |
| SummarizeBy | Optional | Microsoft.Exchange.Data.MultiValuedProperty |
The SummarizeBy parameter returns totals based on the values you specify. If your report filters data using any of the values accepted by this parameter, you can use the SummarizeBy parameter to summarize the results based on those values. To decrease the number of rows returned in the report, consider using the SummarizeBy parameter. Summarizing reduces the amount of data that's retrieved for the report, and delivers the report faster. For example, instead of seeing each instance of a specific value of For the Get-MailTrafficPolicyReport cmdlet, the SummarizeBy parameter accepts the values |
| TransportRule | Optional | Microsoft.Exchange.Data.MultiValuedProperty | The TransportRule parameter filters the report by the name of the transport rule. You can specify multiple values separated by commas. If the value contains spaces, enclose the value in quotation marks ("). |
To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.
To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.
