ServiceDeliveryReport report
The ServiceDeliveryReport REST URI provides configuration and status on the Office 365 organization's email Send Connectors (also known as "Outbound Connectors"). Use this report with the OutboundConnectorReport report to help verify, monitor, and troubleshoot Mailflow and connector configuration issues. This report doesn't have a time-duration like other reports, but instead reports the currently existing outbound (send) connectors. For more information, see Exchange Server 2013 Connectors.
Applies to: Office 365
In this article
REST URIs
Fields
Remarks
Examples
Input parameters and report output columns
Compatibility
Corresponding PowerShell cmdlets
Permissions
Data granularity, persistence and availability
REST URIs
https://reports.office365.com/ecp/reportingwebservice/reporting.svc/ServiceDeliveryReport[?ODATA options]
Fields
The following fields can be specified in $select, $filter, and $orderby ODATA2 query options. All fields are returned if no $select option is provided.
Name |
WCF Type* |
EDM Type* |
[In/Out]** Description |
Example values |
Added in service version |
|---|---|---|---|---|---|
ConnectorName |
string |
Edm.String |
[In/Out] The connector name, set when the connector was created, and retrieved using the OutboundConnectorReport. |
OutConn-1F35-07 |
2013-V1 |
IsListeningOnPort25 |
boolean |
Edm.Boolean |
[In/Out] When true, the send connector's target mail system appears to be listening on TCP/IP port 25, the default SMTP port. |
True |
2013-V1 |
IsOnPremMailbox |
boolean |
Edm.Boolean |
[In/Out] When true, the send connector's target is an on-premises Exchange mailbox. |
True |
2013-V1 |
IsSuccessfullyReceivingMail |
boolean |
Edm.Boolean |
[In/Out] When true, the last time the send connector was used, the message was transferred successfully. |
True |
2013-V1 |
Organization |
string |
Edm.String |
[In/Out] The name of the organization. |
example.onmicrosoft.com |
2013-V1 |
Recipient |
string |
Edm.String |
[In/Out] The email address of the on-premises mailbox that the connector targets. |
user1@mail.onpremises.example.com |
2013-V1 |
SmartHost |
string |
Edm.String |
[In/Out] The Fully-Qualified Domain Name (FQDN) this Send Connector uses to transfer messages. |
mailrelay.example.com |
2013-V1 |
*WCF Type refers to the .NET Framework data type assigned to the field when you create a Windows Communications Framework (WCF) Service Reference in Visual Studio. The EDM Type refers to the ADO.NET Entity Data Model (EDM) types returned in Atom-formatted reports.
**[In/Out]: For more information, see the Input parameters and report output columns section.
Remarks
Each entry in the report includes several fields of metadata. For more information, see Common metadata returned by the Office 365 Reporting web service.
Examples
Coming soon…
Input parameters and report output columns
The [In/Out] indicators in the fields table have the following meanings:
Fields marked [In] in the fields table are primarily intended for use in $filter=, $orderby= and other query options that restrict which entries the report returns. Fields marked [In] in the fields table can be included the $select= option, and they will appear in the report entries, but they will contain no useful data.
Fields marked [In/Out] in the fields table can be used in both column selection ($select=) and entry restriction ($filter= and $orderby=) options. When you include one of these fields in the $select= option, they will appear in the report entries, and will contain useful data when it is available.
Compatibility
ServiceDeliveryReport was introduced in Office 365 service version 2013-V1. For more information about versioning, see Versioning in the Office 365 Reporting web service.
Corresponding PowerShell cmdlets
ServiceDeliveryReport returns the same information as the Get-ServiceDeliveryReport Windows PowerShell cmdlet.
Permissions
The account you access the reports from must have administrative permissions in that Office 365 organization. If the account can view this report in the Office 365 control panel, then the account has permissions to retrieve the data from the REST web service. This report requires the user to be assigned to the View-Only Recipients Role. In the default Office 365 permissions structure, users with the following administrator permissions can access this report: billing administrator, global administrator, password administrator, service administrator, and user management administrator.
Data granularity, persistence and availability
Information available through these reports can be separated into one-day periods, starting at midnight of the time zone reported by the calling application in the HTTP X-timezone header.
The information for this report is available for a period of one year, or until the subscription is cancelled.
Events may be delayed by up to 24 hours before they appear in a report.