reportRoot: getOffice365GroupsActivityDetail

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Get details about Microsoft 365 groups activity by group.

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

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 information, see Authorization for APIs to read Microsoft 365 usage reports.

HTTP request

GET /reports/getOffice365GroupsActivityDetail(period='{period_value}')
GET /reports/getOffice365GroupsActivityDetail(date={date_value})

Function parameters

In the request URL, provide one of the following parameters 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.
date	Date	Specifies the date for which you would like to view the users who performed any activity. {date_value} must have a format of YYYY-MM-DD. As this report is only available for the past 30 days, {date_value} should be a date from that range.

Note: You need to set either period or date in the URL.

This method supports the $format, $top, and $skipToken OData query parameters 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 set to text/csv or application/json.

Request headers

Name	Description
Authorization	Bearer {token}. Required. Learn more about authentication and authorization.

Response

CSV

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
• Group Display Name
• Is Deleted
• Owner Principal Name
• Last Activity Date
• Group Type
• Member Count
• External Member Count
• Exchange Received Email Count
• SharePoint Active File Count
• Yammer Posted Message Count
• Yammer Read Message Count
• Yammer Liked Message Count
• Teams Channel Messages Count
• Teams Meetings Organized Count
• Exchange Mailbox Total Item Count
• Exchange Mailbox Storage Used (Byte)
• SharePoint Total File Count
• SharePoint Site Storage Used (Byte)
• Group Id
• Report Period

The following columns aren't supported in Microsoft Graph China operated by 21Vianet:

• Yammer Posted Message Count
• Yammer Read Message Count
• Yammer Liked Message Count
• Teams Channel Messages Count
• Teams Meetings Organized Count

JSON

If successful, this method returns a 200 OK response code and an office365GroupsActivityDetail object in the response body.

The following properties in office365GroupsActivityDetail object aren't supported in Microsoft Graph China operated by 21Vianet:

• yammerPostedMessageCount
• yammerReadMessageCount
• yammerLikedMessageCount
• teamsChannelMessagesCount
• teamsMeetingsOrganizedCount

The default page size for this request is 200 items.

Example

CSV

Here's an example that outputs CSV.

Request

Here's an example of the request.

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

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,Group Display Name,Is Deleted,Owner Principal Name,Last Activity Date,Group Type,Member Count,External Member Count,Exchange Received Email Count,SharePoint Active File Count,Yammer Posted Message Count,Yammer Read Message Count,Yammer Liked Message Count,Teams Channel Messages Count,Teams Meetings Organized Count,Exchange Mailbox Total Item Count,Exchange Mailbox Storage Used (Byte),SharePoint Total File Count,SharePoint Site Storage Used (Byte),Group Id,Report Period

JSON

Here's an example that returns JSON.

Request

Here's an example of the request.

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

Response

Here's an example of the response.

Note: The response object shown here might be shortened for readability.

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

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(microsoft.graph.office365GroupsActivityDetail)", 
  "value": [
    {
      "groupId": "0003cf63-7ff3-4471-b24b-50ffbfb8b5d2",
      "reportRefreshDate": "2017-09-01", 
      "groupDisplayName": "groupDisplayName-value", 
      "isDeleted": false, 
      "ownerPrincipalName": "ownerDisplayName-value", 
      "lastActivityDate": "2017-08-31", 
      "groupType": "Private", 
      "memberCount": 5, 
      "externalMemberCount": 0, 
      "exchangeReceivedEmailCount": 341, 
      "sharePointActiveFileCount": 0, 
      "yammerPostedMessageCount": 0, 
      "yammerReadMessageCount": 0, 
      "yammerLikedMessageCount": 0, 
      "teamsChannelMessagesCount": 0,
      "teamsMeetingsOrganizedCount": 0,
      "exchangeMailboxTotalItemCount": 343, 
      "exchangeMailboxStorageUsedInBytes": 3724609, 
      "sharePointTotalFileCount": 0, 
      "sharePointSiteStorageUsedInBytes": 0, 
      "reportPeriod": "30"
    }
  ]
}