Edit

List groupAnalytics

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 a list of the groupAnalytics objects and their properties for a Microsoft Entra tenant. Each object holds point-in-time identity analytics for one group.

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 Directory.Read.All
Delegated (personal Microsoft account) Not supported. Not supported.
Application Reports.Read.All Directory.Read.All

Important

For delegated access using work or school accounts, the signed-in user must be assigned a supported Microsoft Entra role or a custom role that grants the permissions required for this operation. This operation supports the following built-in roles, which provide only the least privilege necessary:

  • Reports Reader
  • Security Reader
  • Security Administrator

HTTP request

GET /reports/identityAnalytics/groups

Optional query parameters

This method supports the $count, $filter, $orderby, $select, and $top OData query parameters to help customize the response. The $filter operators and $orderby support available for each property are listed in the groupAnalytics properties table.

Across the resource, $filter supports the eq, ne, gt, ge, lt, and le operators, the and and or logical operators, and the startsWith, endsWith, and contains string functions, depending on the property type. The not and has operators aren't supported.

To get the number of matching groups, append /$count to the request URL (for example, GET /reports/identityAnalytics/groups/$count) or add the $count=true query parameter to return the count inline as the @odata.count property. Large result sets are paged; follow the @odata.nextLink URL in the response to retrieve the next page. For general information, see OData query parameters.

Request headers

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

Request body

Don't supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and a collection of groupAnalytics objects in the response body.

Examples

Example 1: Get a list of groupAnalytics objects

Request

The following example shows a request.

GET https://graph.microsoft.com/beta/reports/identityAnalytics/groups

Response

The following example shows the response.

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

HTTP/1.1 200 OK
Content-type: application/json

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#reports/identityAnalytics/groups",
  "value": [
    {
      "id": "1f3a3b9c-6e2c-4f0a-9b2c-9a6d4d2e8f10",
      "tenantId": "5d6f7a8b-1c2d-3e4f-5a6b-7c8d9e0f1a2b",
      "displayName": "Sales Team",
      "calculatedDateTime": "2026-06-08T00:00:00Z",
      "createdDateTime": "2023-02-15T10:30:00Z",
      "groupType": "isCloudGroup",
      "isValidGroup": true,
      "isCloudM365Group": true,
      "isDynamicGroup": false,
      "directGroupMemberCount": 3,
      "transitiveUserCount": 412,
      "memberTransitiveUserCount": 405,
      "guestTransitiveUserCount": 7,
      "assignedRoleCount": 1
    },
    {
      "id": "9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d",
      "tenantId": "5d6f7a8b-1c2d-3e4f-5a6b-7c8d9e0f1a2b",
      "displayName": "Engineering - All",
      "calculatedDateTime": "2026-06-08T00:00:00Z",
      "createdDateTime": "2021-11-03T08:00:00Z",
      "groupType": "isCloudGroup",
      "isValidGroup": true,
      "isCloudM365Group": false,
      "isCloudSecurityGroup": true,
      "isDynamicGroup": true,
      "directGroupMemberCount": 12,
      "transitiveUserCount": 1890,
      "memberTransitiveUserCount": 1890,
      "guestTransitiveUserCount": 0,
      "assignedRoleCount": 0
    }
  ]
}

Example 2: Get valid groups that contain guests, with selected properties

Request

The following example uses $filter to return only valid groups that contain at least one transitive guest user. It uses $select to limit the returned properties, $orderby to sort the results by creation date, and $top to return at most 10 results.

GET https://graph.microsoft.com/beta/reports/identityAnalytics/groups?$filter=isValidGroup eq true and guestTransitiveUserCount gt 0&$select=id,displayName,createdDateTime,groupType,transitiveUserCount,guestTransitiveUserCount&$orderby=createdDateTime desc&$top=10

Response

The following example shows the response.

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

HTTP/1.1 200 OK
Content-type: application/json

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#reports/identityAnalytics/groups(id,displayName,createdDateTime,groupType,transitiveUserCount,guestTransitiveUserCount)",
  "value": [
    {
      "id": "1f3a3b9c-6e2c-4f0a-9b2c-9a6d4d2e8f10",
      "displayName": "Sales Team",
      "createdDateTime": "2023-02-15T10:30:00Z",
      "groupType": "isCloudGroup",
      "transitiveUserCount": 412,
      "guestTransitiveUserCount": 7
    }
  ]
}
  • Last updated on