copilotReportRoot: getMicrosoft365CopilotUserCountSummary

重要

/beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。

指定した期間における Microsoft 365 Copilot のアクティブ ユーザーと有効ユーザーの集計数を取得します。

レポートのビューと名前の詳細については、「Microsoft 365 レポート - Microsoft 365 Copilot の使用状況」を参照してください。 Copilot 使用状況レポート API は、Microsoft Graph 名前空間で標準 REST API として使用できます。 詳細については、「Microsoft 365 Copilot API の概要」を参照してください。

この API は、次の国内クラウド展開で使用できます。

グローバル サービス 米国政府機関 L4 米国政府機関 L5 (DOD) 21Vianet が運営する中国
✅ ❌ ❌ ❌

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。

アクセス許可の種類 最小特権アクセス許可 より高い特権のアクセス許可
委任 (職場または学校のアカウント) Reports.Read.All 注意事項なし。
委任 (個人用 Microsoft アカウント) サポートされていません。 サポートされていません。
アプリケーション Reports.Read.All 注意事項なし。

重要

アプリがユーザーに代わってサービス使用状況レポートを読み取ることを許可する委任されたアクセス許可の場合、テナント管理者は、次のいずれかの Microsoft Entra ID の制限付き管理者ロールをユーザーに割り当てている必要があります:

  • 社内管理者
  • AI 管理者
  • Exchange 管理者
  • SharePoint 管理者
  • Lync 管理者
  • Teams サービス管理者
  • Teams 通信管理者
  • グローバル閲覧者
  • 使用状況の概要レポート閲覧者
  • レポート閲覧者

詳細については、「 API が Microsoft 365 の使用状況レポートを読み取るための承認」を参照してください。

HTTP 要求

GET https://graph.microsoft.com/v1.0/copilot/reports/getMicrosoft365CopilotUserCountSummary(period={period}, version={version})

GET https://graph.microsoft.com/beta/copilot/reports/getMicrosoft365CopilotUserCountSummary(period={period}, version={version})

関数パラメーター

要求 URL で、次のクエリ パラメーターに値を指定します。

パラメーター 型 説明
period String 必須です。 集計使用状況を報告する過去の日数。 サポートされている値は、 version の値によって異なります。 v1、D7、D30、D90、D180、ALL です。 v2 の場合は、D7、D28、D90、D180、ALL です。 最初の 4 つの値はフォーマット Dn に従います。ここで、 n はデータを集計する過去の日数を表します。 ALL サポートされているすべての期間 ( v1 の場合は 7、30、90、および 180 日、 v2の場合は 7、28、90、および 180 日) の使用状況を報告することを示します。
version String 省略可能。 要求されたレポート バージョン。 サポートされている値は v2 (既定値) です。

レポートのバージョン

バージョン 1 レポートには、次の情報が含まれています。

  • レポートの更新日
  • レポート期間
  • Microsoft Teams 対応ユーザー
  • Microsoft Teams のアクティブ ユーザー
  • Word 対応ユーザー
  • Word のアクティブ ユーザー
  • PowerPoint 対応ユーザー
  • PowerPoint のアクティブ ユーザー
  • Outlook が有効なユーザー
  • Outlook アクティブ ユーザー
  • Excel が有効なユーザー
  • Excel アクティブ ユーザー
  • OneNote が有効なユーザー
  • OneNote アクティブ ユーザー
  • Loop 対応ユーザー
  • Loop のアクティブ ユーザー
  • すべてのアプリが有効なユーザー
  • すべてのアプリのアクティブ ユーザー
  • Copilot Chat が有効なユーザー
  • Copilot Chat のアクティブ ユーザー

バージョン 2 のレポートには、バージョン 1 のすべての情報と次の追加情報が含まれています。

  • Edge 対応ユーザー
  • Edge のアクティブ ユーザー
  • Microsoft 365 Copilot 対応ユーザー
  • Microsoft 365 Copilot のアクティブ ユーザー
  • Copilot Chat (職場) が有効なユーザー
  • Copilot Chat (職場) アクティブ ユーザー
  • Copilot Chat (Web) が有効なユーザー
  • Copilot Chat (Web) のアクティブ ユーザー
  • 送信されたプロンプトの合計数
  • 送信された平均プロンプト

要求ヘッダー

名前 説明
Authorization Bearer {token}. 必須です。 認証と認可についての詳細をご覧ください。

要求本文

このメソッドには、要求本文を指定しません。

応答

成功した場合、この関数は 200 OK 応答コードと応答本文のストリームを返します。 ストリームの内容は、要求されたレポートを含む CSV ファイルです。

成功した場合、この関数は 200 OK 応答コードと、要求されたレポートの JSON 表現を応答本文で返します。

例

要求

次の例は要求を示しています。

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

応答

次の例は応答を示しています。 ここに示す応答オブジェクトは、読みやすさのために短縮されている可能性があります。

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

Report Refresh Date,Report Period,Microsoft Teams Enabled Users,Microsoft Teams Active Users,Word Enabled Users,Word Active Users,PowerPoint Enabled Users,PowerPoint Active Users,Outlook Enabled Users,Outlook Active Users,Excel Enabled Users,Excel Active Users,OneNote Enabled Users,OneNote Active Users,Loop Enabled Users,Loop Active Users,Any App Enabled Users,Any App Active Users,Copilot Chat Enabled Users,Copilot Chat Active Users
2026-07-03,7,25,0,25,0,25,0,25,0,25,0,25,0,25,0,25,0,25,0

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

{
  "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
        }
      ]
    }
  ]
}
  • 最終更新: