reportRoot: getSharePointSiteUsageSiteCounts

• 12/18/2019
• 3 minutes to read
• • 
  • 
  • 
  • 
  • 
  • +1

Get the total number of files across all sites and the number of active files. A file (user or system) is considered active if it has been saved, synced, modified, or shared within the specified time period.

Note: For details about different report views and names, see Office 365 Reports - SharePoint site 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 more details, see Authorization for APIs to read Office 365 usage reports.

HTTP request

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

Function parameters

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

Request headers

Response

If successful, this method 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
• Site Type
• Total
• Active
• Report Date
• Report Period

Example

Request

The following is an example of the request.

GET https://graph.microsoft.com/v1.0/reports/getSharePointSiteUsageSiteCounts(period='D7')

GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var report = await graphClient.Reports
	.GetSharePointSiteUsageSiteCounts("D7")
	.Request()
	.GetAsync();

const options = {
	authProvider,
};

const client = Client.init(options);

let res = await client.api('/reports/getSharePointSiteUsageSiteCounts(period='D7')')
	.get();

MSHTTPClient *httpClient = [MSClientFactory createHTTPClientWithAuthenticationProvider:authenticationProvider];

NSString *MSGraphBaseURL = @"https://graph.microsoft.com/v1.0/";
NSMutableURLRequest *urlRequest = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:[MSGraphBaseURL stringByAppendingString:@"/reports/getSharePointSiteUsageSiteCounts(period='D7')"]]];
[urlRequest setHTTPMethod:@"GET"];

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

		MSGraphReport *report = [[MSGraphReport alloc] initWithData:data error:&nserror];

}];

[meDataTask execute];

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

Report report = graphClient.reports()
	.getSharePointSiteUsageSiteCounts("D7")
	.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,Site Type,Total,Active,Report Date,Report Period