Get-MailTrafficSummaryReport
Applies to: Exchange Online, Exchange Online Protection
This cmdlet is available only in the cloud-based service.
Use the Get-MailTrafficSummaryReport cmdlet to view summary information about message traffic in your organization.
For information about the parameter sets in the Syntax section below, see Syntax.
Get-MailTrafficSummaryReport [-Category <String>] [-DlpPolicy <MultiValuedProperty>] [-Domain <MultiValuedProperty>] [-EndDate <DateTime>] [-Expression <Expression>] [-Page <Int32>] [-PageSize <Int32>] [-ProbeTag <String>] [-StartDate <DateTime>] [-TransportRule <MultiValuedProperty>]
This example shows the top spam recipient statistics between June 13, 2015 and June 15, 2015.
Get-MailTrafficSummaryReport -Category TopSpamRecipient -StartDate 06/13/2015 -EndDate 06/15/2015
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 |
|---|---|---|---|
| Category | Optional | System.String | The Category parameter filters the report by category. Value values for this parameter are: |
| DlpPolicy | Optional | Microsoft.Exchange.Data.MultiValuedProperty | The DlpPolicy parameter filters the report by the name of the data loss prevention (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". |
| 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". |
| 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.
