MailboxUsageDetail report
Important: These reports are deprecated as of January 29, 2018. We recommend that you use the Microsoft Graph Mailbox usage reports instead.
The MailboxUsageDetail REST URI provides more-detailed statistics about Office 365 mailbox usage. Use this report with the MailboxUsage report to get the summary information for the organization.
Applies to: Office 365
REST URIs
https://reports.office365.com/ecp/reportingwebservice/reporting.svc/MailboxUsage[?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 |
|---|---|---|---|---|---|
CurrentMailboxSize |
long |
Edm.Int64 |
[In/Out] The amount of data used by the Office 365 mailbox, in bytes |
2650034 |
2013-V1 |
Date |
System.DateTime |
Edm.DateTime |
[In/Out] The end date and time of the reporting period. See below for more information about reporting periods. |
Short Date (for example, 03/10/2013) or Date Time with quotes (for example, "03/10/2013 4:55 PM") |
2013-V1 |
IsInactive |
Edm.Boolean |
None specified |
[In/Out] When true, indicates the mailbox has not been accessed by the user in more than 30 days. |
false |
2013-V1 |
MailboxPlan |
string |
None specified |
[In/Out] The name of the Office 365 subscription plan that applies to the mailbox. |
||
MailboxSize |
long |
Edm.Int64 |
[In/Out] The total maximum size of the Office 365 mailbox, in bytes |
265003555 |
2013-V1 |
PercentUsed |
long |
Edm.Int64 |
[In/Out] The percentage of Office 365 mailbox space in use during the indicted reporting entry. |
99 |
2013-V1 |
TenantGuid |
System.guid |
Edm.Guid |
[In/Out] The GUID of the organization. |
16a58f78-539f-47f7-b9bf-02a63867d73b |
2013-V1 |
TenantName |
string |
None specified |
[In/Out] The name of the organization. |
example.onmicrosoft.com |
2013-V1 |
UserName |
string |
None specified |
[In/Out] The display name of the mailbox owner |
MailboxUser1 |
2013-V1 |
WindowsLiveID |
string |
None specified |
[In/Out] The Windows Live ID User Principal Name of the mailbox |
MailboxUser1@example.onmicrosoft.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]: 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
The MailboxUsageDetail report was introduced in Office 365 service version 2013-V1. For more information on versioning, see Versioning in the Office 365 Reporting web service.
Corresponding PowerShell cmdlets
The MailboxUsageDetail report returns the same information as the Get-MailboxUsageDetailReport Windows PowerShell cmdlet.
Note
This cmdlet is deprecated. We don’t recommend that you use it in your production environment.
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.