Commands › Exchange Online

Get-ATPTotalTrafficReport

Exchange Online ExchangeOnlineManagement Get-*

Use the Get-ATPTotalTrafficReport to view details about message traffic in your Microsoft Defender for Office 365 organization.

Quick start script

# Get-ATPTotalTrafficReport — quick start (serv365.ai)
# 1. Connect (app-only shown; interactive: omit the certificate parameters)
Connect-ExchangeOnline -CertificateThumbprint $thumb -AppId $appId -Organization $org

# 2. Run and inspect
Get-ATPTotalTrafficReport | Format-List

# 3. Export for evidence / drift tracking
Get-ATPTotalTrafficReport | Export-Clixml .\ATPTotalTrafficReport-$(Get-Date -Format yyyyMMdd).xml

Syntax

Get-ATPTotalTrafficReport
 [-Action <MultiValuedProperty>]
 [-AggregateBy <String>]
 [-Direction <MultiValuedProperty>]
 [-Domain <MultiValuedProperty>]
 [-EndDate <System.DateTime>]
 [-Page <Int32>]
 [-PageSize <Int32>]
 [-ProbeTag <String>]
 [-StartDate <System.DateTime>]
 [-SummarizeBy <MultiValuedProperty>]
 [<CommonParameters>]

Parameters (10)

Parameter	Type	What it controls
-Action	MultiValuedProperty	The Action parameter filters the report by the action taken on messages. To view the complete list of valid values for this parameter, run the command: `Get-MailFilterListReport -SelectionTarget Actions`. The action...
-AggregateBy	String	The AggregateBy parameter specifies the reporting period. Valid values are Hour, Day or Summary. The default value is Day.
-Direction	MultiValuedProperty	The Direction parameter filters the results by incoming or outgoing messages. Valid values are:
-Domain	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 All.
-EndDate	DateTime	The EndDate parameter specifies the end date of the date range.
-Page	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	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	String	This parameter is reserved for internal Microsoft use.
-StartDate	DateTime	The StartDate parameter specifies the start date of the date range.
-SummarizeBy	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...

Reference facts derived from Microsoft documentation, © Microsoft, licensed CC BY 4.0; restructured with original guidance by serv365.ai.