Redagować

Udostępnij przez

copilotReportRoot: getMicrosoft365CopilotUserCountSummary

Important

APIs under the /beta version are subject to change. Use of these APIs in production applications is not supported.

Get the aggregated number of active and enabled users of Microsoft 365 Copilot for a specified time period.

For more information about report views and names, see Microsoft 365 reports - Microsoft 365 Copilot usage. Copilot usage reports APIs are available as standard REST APIs under the Microsoft Graph namespace. For more information, see Microsoft 365 Copilot APIs overview.

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.

Important

For delegated permissions to allow apps to read service usage reports on behalf of a user, the tenant administrator must have assigned the user one of the following Microsoft Entra ID limited administrator roles:

  • Company Administrator
  • AI Administrator
  • Exchange Administrator
  • SharePoint Administrator
  • Lync Administrator
  • Teams Service Administrator
  • Teams Communications Administrator
  • Global Reader
  • Usage Summary Reports Reader
  • Reports Reader

For more information, see Authorization for APIs to read Microsoft 365 usage reports.

HTTP request

GET https://graph.microsoft.com/v1.0/copilot/reports/getMicrosoft365CopilotUserCountSummary

GET https://graph.microsoft.com/beta/copilot/reports/getMicrosoft365CopilotUserCountSummary

Function parameters

In the request URL, provide the following query parameters with values.

Parameter Type Description
period String The number of previous days over which to report aggregated usage. The supported values are: D7, D30, D90, D180, ALL. The first four values follow the format Dn where n represents the number of days over which to aggregate data. ALL indicates to report usage for 7, 30, 90, and 180 days.

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 function returns a 200 OK response code and a Stream in the response body.

Examples

Request

The following example shows a request.

GET https://graph.microsoft.com/v1.0/copilot/reports/getMicrosoft365CopilotUserCountSummary(period='D7')?$format=application/json

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

Response

The following example shows the response. The response object shown here might be shortened for readability.

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

{
  "value": [
    {
      "reportRefreshDate": "2025-08-20",
      "adoptionByProduct": [
        {
          "reportPeriod": 7,
          "anyAppEnabledUsers": 359229,
          "anyAppActiveUsers": 165115,
          "microsoftTeamsEnabledUsers": 359096,
          "microsoftTeamsActiveUsers": 123341,
          "wordEnabledUsers": 359096,
          "wordActiveUsers": 21459,
          "powerPointEnabledUsers": 359096,
          "powerPointActiveUsers": 8530,
          "outlookEnabledUsers": 359096,
          "outlookActiveUsers": 37270,
          "excelEnabledUsers": 359096,
          "excelActiveUsers": 6709,
          "oneNoteEnabledUsers": 359096,
          "oneNoteActiveUsers": 1660,
          "loopEnabledUsers": 359096,
          "loopActiveUsers": 1345,
          "copilotChatEnabledUsers": 359096,
          "copilotChatActiveUsers": 65480
        }
      ]
    }
  ]
}
  • Last updated on