reportRoot: getTeamsUserActivityUserCounts
Namespace: microsoft.graph
Get the number of Microsoft Teams users by activity type. The activity types are number of teams chat messages, private chat messages, calls, or meetings.
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 ID limited administrator role. For more details, see Authorization for APIs to read Microsoft 365 usage reports.
HTTP request
GET /reports/getTeamsUserActivityUserCounts(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. |
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
- Report Date
- Team Chat Messages
- Private Chat Messages
- Calls
- Meetings
- Other Actions
- Report Period
Example
Request
The following example shows a request.
GET https://graph.microsoft.com/v1.0/reports/getTeamsUserActivityUserCounts(period='D7')
Response
The following example shows 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 Date,Team Chat Messages,Private Chat Messages,Calls,Meetings,Other Actions,Report Period