reportRoot: getM365AppPlatformUserCounts

• 1/26/2021
• 6 minutes to read
• • s
  • L
  • a
  • D
  • d

Namespace: microsoft.graph

Get a report that provides the trend of active users across all apps for each platform – Windows, Mac, web, and mobile - in your organization.

Note: For details about different report views and names, see Microsoft 365 reports - Microsoft 365 Apps usage.

Permissions

One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Note: For delegated permissions to allow apps to read service usage reports on behalf of a user, the tenant administrator must have assigned the user the appropriate Azure AD limited administrator role. For details, see Authorization for APIs to read Microsoft 365 usage reports.

HTTP request

GET /reports/getM365AppPlatformUserCounts(period='{period_value}')

Function parameters

In the request URL, provide the following parameter with a valid value.

Optional query parameters

This method supports the $format OData query parameter to customize the response. The default output type is text/csv. However, if you want to specify the output type, you can use the OData $format query parameter to set the default output to text/csv or application/json.

Request headers

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a 200 OK response code and a report object in the response body. Report data is contained in the content property of the report object.

CSV

If successful, requesting the content property returns a 302 Found response that redirects to a preauthenticated download URL for the report. That URL can be found in the Location header in the response.

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

The CSV file has the following headers for columns:

• Report Refresh Date
• Report Period
• Report Date
• Outlook
• Word
• Excel
• PowerPoint
• OneNote
• Teams

JSON

If successful, requesting the content property returns a 200 OK response code and a JSON object in response body.

Examples

Example 1: CSV output

The following is an example that outputs CSV.

Request

The following is an example of the request to get the content property.

GET https://graph.microsoft.com/beta/reports/getM365AppPlatformUserCounts(period='D7')/content?$format=text/csv

GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var stream = await graphClient.Reports
	.GetM365AppPlatformUserCounts("D7").Content
	.Request()
	.GetAsync();

const options = {
	authProvider,
};

const client = Client.init(options);

let stream = await client.api('/reports/getM365AppPlatformUserCounts(period='D7')/content')
	.version('beta')
	.get();

MSHTTPClient *httpClient = [MSClientFactory createHTTPClientWithAuthenticationProvider:authenticationProvider];

NSString *MSGraphBaseURL = @"https://graph.microsoft.com/beta/";
NSMutableURLRequest *urlRequest = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:[MSGraphBaseURL stringByAppendingString:@"/reports/getM365AppPlatformUserCounts(period='D7')/content?$format=text/csv"]]];
[urlRequest setHTTPMethod:@"GET"];

MSURLSessionDataTask *meDataTask = [httpClient dataTaskWithRequest:urlRequest 
	completionHandler: ^(NSData *data, NSURLResponse *response, NSError *nserror) {

		MSGraphStream *stream = [[MSGraphStream alloc] initWithData:data error:&nserror];

}];

[meDataTask execute];

GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

InputStream stream = graphClient.customRequest("/reports/getM365AppPlatformUserCounts(period='D7')/content", InputStream.class)
	.buildRequest()
	.get();

Response

The following 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 CSV file that downloads will have the following schema.

HTTP/1.1 200 OK
Content-Type: application/octet-stream

Report Refresh Date,Report Period,Report Date,Windows,Mac,Mobile,Web

Example 2: JSON output

The following is an example that returns JSON.

Request

The following is an example of the request to get the content property.

GET https://graph.microsoft.com/beta/reports/getM365AppPlatformUserCounts(period='D7')/content?$format=application/json

GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var stream = await graphClient.Reports
	.GetM365AppPlatformUserCounts("D7").Content
	.Request()
	.GetAsync();

const options = {
	authProvider,
};

const client = Client.init(options);

let stream = await client.api('/reports/getM365AppPlatformUserCounts(period='D7')/content')
	.version('beta')
	.get();

MSHTTPClient *httpClient = [MSClientFactory createHTTPClientWithAuthenticationProvider:authenticationProvider];

NSString *MSGraphBaseURL = @"https://graph.microsoft.com/beta/";
NSMutableURLRequest *urlRequest = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:[MSGraphBaseURL stringByAppendingString:@"/reports/getM365AppPlatformUserCounts(period='D7')/content?$format=application/json"]]];
[urlRequest setHTTPMethod:@"GET"];

MSURLSessionDataTask *meDataTask = [httpClient dataTaskWithRequest:urlRequest 
	completionHandler: ^(NSData *data, NSURLResponse *response, NSError *nserror) {

		MSGraphStream *stream = [[MSGraphStream alloc] initWithData:data error:&nserror];

}];

[meDataTask execute];

GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

InputStream stream = graphClient.customRequest("/reports/getM365AppPlatformUserCounts(period='D7')/content", InputStream.class)
	.buildRequest()
	.get();

Response

The following is an example of the response.

Note: The response object shown here might be shortened for readability. All the properties will be returned from an actual call.

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 156

{
  "value": [
    {
      "reportRefreshDate": "2020-06-30",
      "reportPeriod": 7,
      "userCounts": [
        {
          "reportDate": "2020-06-30",
          "windows": 1445,
          "mac": 146,
          "mobile": 1131,
          "web": 1080
        }
      ]
    }
  ]
}