reportRoot: getMailboxUsageMailboxCounts

名前空間: microsoft.graph

組織内のユーザー メールボックスの合計数と、レポート期間中の各日にアクティブなメールボックス数を取得します。 メールボックスは、ユーザーが何らかの電子メールを送信するか、読んだ場合にアクティブとみなされます。

注: 別のレポートのビューとレポート名についての詳細は、「Microsoft 365 レポート: メールボックスの使用状況」を参照してください。

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

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

アクセス許可

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

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

: アプリがユーザーに代わってサービス使用状況レポートを読み取ることができるように委任されたアクセス許可の場合、テナント管理者は、ユーザーに適切なMicrosoft Entra制限付き管理者ロールを割り当てる必要があります。 詳細については、「Microsoft 365 利用状況レポートを読み込むための API 用の承認」を参照してください。

HTTP 要求

GET /reports/getMailboxUsageMailboxCounts(period='{period_value}')

関数パラメーター

要求 URL に、次のパラメーターと有効な値を指定します。

パラメーター 説明
period 文字列 レポートを集計する期間の長さを指定します。 {period_value} でサポートされている値は D7、D30、D90、D180 です。 これらの値は、Dn の形式 (n はレポートを集計する日数) に従います。 必須。

要求ヘッダー

名前 説明
Authorization ベアラー {token}。 必須です。 認証と承認の詳細については、こちらをご覧ください。
If-None-Match この要求ヘッダーが含まれている場合、指定された eTag がファイルの現在のタグに一致すると、304 Not Modified 応答コードが返されます。 省略可能。

応答

成功すると、レポートの事前認証されたダウンロード URL にリダイレクトする 302 Found 応答が返されます。 その URL は、応答の Location ヘッダー内にあります。

事前認証されたダウンロード URL は、短期間 (数分) のみ有効で、Authorization ヘッダーを必要としません。

この CSV ファイルには、次の列ヘッダーがあります。

  • レポートの更新日
  • 合計
  • アクティブ
  • レポート日付
  • レポート期間

要求

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

GET https://graph.microsoft.com/v1.0/reports/getMailboxUsageMailboxCounts(period='D7')

応答

次の例は応答を示しています。

HTTP/1.1 302 Found
Content-Type: text/plain
Location: https://reports.office.com/data/download/JDFKdf2_eJXKS034dbc7e0t__XDe

302 リダイレクトに従うと、ダウンロードされる CSV ファイルは次のスキーマを持つことになります。

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

Report Refresh Date,Total,Active,Report Date,Report Period