Get MailboxUsage report

Important: APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported.

Retrieve the reports of Exchange Mailbox Usage. The response will be a CSV file in a binary stream.

Note: You can go to Office 365 Reports - Mailbox usage to check the meaning of different views.

Prerequisites

The following scopes are required to execute this API:

  • Reports.Read.All

Note: Permission scopes are listed in least privilege required order.

HTTP request

GET /reports/MailboxUsage(view=view-value, period=period-value)/content

Request headers

Name Description
Authorization Bearer {token}. Required.

Request body

In the request URL, provide following query parameters with values.

Parameter Type Description
view ViewType View is an enumeration type, used to determine which type of information that current report should return. Can not be null.
period PeriodType Period is an enumeration type, used to specify the aggregate type.

Note: If you call with Detail view along with PeriodType, the return data is a list of all users that are licensed for the product with their respective last activity date.

The following ViewType are available in this report:

  • Detail
  • Mailbox
  • Quota
  • Storage

The following PeriodType are available in this report:

  • D7
  • D30
  • D90
  • D180

Response

If successful, this method returns 302 Found response redirecting to a pre-authenticated download URL for the report.

To download the contents of the file your application will need to follow the Location header in the response. Many HTTP client libraries will automatically follow the 302 redirection and start downloading the file immedately.

Pre-authenticated download URLs are only valid for a short period of time (a few minutes) and do not require an Authorization header to download.

Example

Here is an example of how to call this API.

Request

Here is an example of the request.

GET https://graph.microsoft.com/beta/reports/MailboxUsage(view='Detail',period='D7')/content
Response

Here is an example of the response.

HTTP/1.1 302 Found
Content-Type: text/plain
Location: https://reports.office.com/data/download/JDFKdf2_eJXKS034dbc7e0t__XDe

Follow the 302 redirection and the downloading CSV file will have the schema as follows.

HTTP/1.1 200 OK
Data as of,User principal name,DisplayName,Deleted,Deleted date,CreatedDate,Last activity date (UTC),Item count,Storage used (B),Issue warning quota (B),Prohibit send quota (B),Prohibit send/receive quota (B),Reporting period in days

Other valid requests

GET https://graph.microsoft.com/beta/reports/MailboxUsage(view='Mailbox',period='D7')/content
GET https://graph.microsoft.com/beta/reports/MailboxUsage(view='Quota',period='D7')/content
GET https://graph.microsoft.com/beta/reports/MailboxUsage(view='Storage',period='D7')/content