Export (0) Print
Expand All
Expand Minimize

Get-MailTrafficReport

Exchange 2013
 

Applies to: Exchange Online Protection, Exchange Online

Topic Last Modified: 2013-01-08

This cmdlet is available only in the cloud-based service.

Use the Get-MailTrafficReport cmdlet to view details about message traffic in your organization.

For information about the parameter sets in the Syntax section below, see Syntax.

Get-MailTrafficReport [-Action <MultiValuedProperty>] [-AggregateBy <String>] [-Direction <MultiValuedProperty>] [-Domain <MultiValuedProperty>] [-EndDate <DateTime>] [-EventType <MultiValuedProperty>] [-Expression <Expression>] [-Organization <OrganizationIdParameter>] [-Page <Int32>] [-PageSize <Int32>] [-ProbeTag <String>] [-StartDate <DateTime>] [-SummarizeBy <MultiValuedProperty>]

This example retrieves details for incoming messages between June 13, 2012 and June 15, 2012.

Get-MailTrafficReport -Direction Inbound -StartDate 06/13/2012 -EndDate 06/15/2012

This example retrieves the statistics for outgoing messages on December 12, 2012, and displays the results in a table. Every unique combination of EventType and Action is displayed on a separate row in the table.

Get-MailTrafficReport -StartDate 12/12/2012 -EndDate 12/12/2012 -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-MailTrafficReport -StartDate 12/12/2012 -EndDate 12/12/2012 -Direction Outbound -SummarizeBy Domain,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 Get-MailFilterListReport -SelectionTarget Actions. The action you specify must correspond to the report type. For example, you can only specify malware filter actions for malware reports.

You can specify multiple values separated by commas.

AggregateBy

Optional

System.String

The AggregateBy parameter specifies the reporting period. Valid values for this parameter are: Hour, Day or Summary. The default value is Day.

Direction

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The Direction parameter filters the results by incoming or outgoing messages. Valid values for this parameter are Inbound and Outbound.

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.

EndDate

Optional

System.DateTime

The EndDate parameter specifies the end date of the date range.

Use the short date format defined in the Regional Options settings for the computer on which the command is run. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 03/01/2010 to specify March 1, 2010. 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, you must enclose the argument in quotation marks ("), for example, "10/05/2010 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 Get-MailFilterListReport -SelectionTarget EventTypes. The event type you specify must correspond to the report. For example, you can only specify malware filter events for malware reports.

You can specify multiple values separated by commas.

Expression

Optional

System.Linq.Expressions.Expression

This parameter is reserved for internal Microsoft use.

Organization

Optional

Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter

The Organization 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 defined in the Regional Options settings for the computer on which the command is run. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 03/01/2010 to specify March 1, 2010. 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, you must enclose the argument in quotation marks ("), for example, "10/05/2010 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 EventType on an individual row in the report, you can use the SummarizeBy parameter to see the total number of instances of that value of EventType on one row in the report.

For the Get-MailTrafficReport cmdlet, the SummarizeBy parameter accepts the values Action, Domain, and EventType. You can specify multiple values separated by commas.

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.

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft