reportRoot: getSharePointActivityUserCounts

Namespace: microsoft.graph

Get the trend in the number of active users. A user is considered active if they have executed a file activity (save, sync, modify, or share) or visited a page within the specified time period.

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

This API is available in the following national cloud deployments.

Global service US Government L4 US Government L5 (DOD) China operated by 21Vianet

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) Reports.Read.All Not available.
Delegated (personal Microsoft account) Not supported. Not supported.
Application Reports.Read.All Not available.

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 Microsoft Entra limited administrator role. For more information, see Authorization for APIs to read Microsoft 365 usage reports.

HTTP request

GET /reports/getSharePointActivityUserCounts(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. Learn more about authentication and authorization.
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 don't require an Authorization header.

The CSV file has the following headers for columns.

  • Report Refresh Date
  • Visited Page
  • Viewed Or Edited
  • Synced
  • Shared Internally
  • Shared Externally
  • Report Date
  • Report Period

Example

Request

Here's an example of the request.

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

Response

Here's 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 have the following schema.

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

Report Refresh Date,Visited Page,Viewed Or Edited,Synced,Shared Internally,Shared Externally,Report Date,Report Period