reportRoot: getSharePointSiteUsageSiteCounts
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.
Permission type | Permissions (from least to most privileged) |
---|---|
Delegated (work or school account) | Reports.Read.All |
Delegated (personal Microsoft account) | Not supported. |
Application | Reports.Read.All |
HTTP request
GET /reports/getSharePointSiteUsageSiteCounts(period='{period_value}')
Function parameters
In the request URL, provide the following parameter with a valid value.
Parameter | Type | Description |
---|---|---|
period | string | Specifies the length of time over which the report is aggregated. The supported values for {period_value} are: D7, D30, D90, and D180. These values follow the format Dn where n represents the number of days over which the report is aggregated. Required. |
Request headers
Name | Description |
---|---|
Authorization | Bearer {token}. Required. |
If-None-Match | If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional. |
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')
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
Feedback
Loading feedback...