reportRoot: getFormsUserActivityUserCounts
名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
選択した期間に Microsoft Forms アクティビティを実行するデザイナーまたはレスポンダーの合計数を示すレポートを取得します。
この API は、次の国内クラウド展開で使用できます。
| グローバル サービス | 米国政府機関 L4 | 米国政府機関 L5 (DOD) | 21Vianet が運営する中国 |
|---|---|---|---|
| ✅ | ❌ | ❌ | ❌ |
アクセス許可
この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。
| アクセス許可の種類 | 最小特権アクセス許可 | より高い特権のアクセス許可 |
|---|---|---|
| 委任 (職場または学校のアカウント) | Reports.Read.All | 注意事項なし。 |
| 委任 (個人用 Microsoft アカウント) | サポートされていません。 | サポートされていません。 |
| アプリケーション | Reports.Read.All | 注意事項なし。 |
手記： アプリがユーザーの代わりにサービス使用状況レポートを読み取ることができるように委任されたアクセス許可を付与するには、テナント管理者が適切な Microsoft Entra ID 制限付き管理者ロールをユーザーに割り当てる必要があります。 詳細については、「 Microsoft 365 使用状況レポートを読み取るための API の承認」を参照してください。
HTTP 要求
GET /reports/getBrowserDistributionUserCounts(period='{period_value}')
関数パラメーター
要求 URL に、次のパラメーターと有効な値を指定します。
| パラメーター | 種類 | 説明 |
|---|---|---|
| period | 文字列 | レポートを集計する期間の長さを指定します。 {period_value} でサポートされる値は、 D7、 D30、 D90、および D180です。 これらの値は、Dn の形式 (n はレポートを集計する日数) に従います。 必須。 |
オプションのクエリ パラメーター
このメソッドは、応答をカスタマイズするために $formatOData クエリ パラメーター をサポートします。 既定の出力の種類は text/csv。 ただし、出力の種類を指定する場合は、OData $format クエリ パラメーターを使用して、既定の出力を text/csv または application/json に設定できます。
要求ヘッダー
| 名前 | 説明 |
|---|---|
| Authorization | ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。 |
要求本文
このメソッドには、要求本文を指定しません。
応答
CSV
成功すると、レポートの事前認証されたダウンロード URL にリダイレクトする 302 Found 応答が返されます。 その URL は、応答の Location ヘッダー内にあります。
事前認証されたダウンロード URL は短時間 (数分) のみ有効であり、 Authorization ヘッダーは必要ありません。
この CSV ファイルには、次の列ヘッダーがあります。
- レポートの更新日
- レポート期間
- デザイナー
- 回答
- TotalUsers
JSON
成功した場合、このメソッドは応答コード 200 OK と応答本文に JSON オブジェクトを返します。
例
例 1: CSV 出力
CSV を出力する例を次に示します。
要求
次の例は要求を示しています。
GET https://graph.microsoft.com/beta/reports/getFormsUserActivityUserCounts(period='D7')?$format=text/csv
応答
次の例は応答を示しています。
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, Report Period, Designers, Respondents, Total Users
例 2: JSON 出力
JSON を返す例を次に示します。
要求
次の例は要求を示しています。
GET https://graph.microsoft.com/beta/reports/getFormsUserActivityUserCounts(period='D7')?$format=application/json
応答
次の例は応答を示しています。
注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 294
{
"value": [
{
"reportRefreshDate": "2022-06-08",
"reportPeriod": 7,
"formsUsageUserCountsByDate": [
{
"reportDate": "2022-06-08",
"designers": 5117,
"respondents": 19061,
"totalUsers": 22539
},
{
"reportDate": "2022-06-07",
"designers": 5245,
"respondents": 19820,
"totalUsers": 23269
},
{
"reportDate": "2022-06-06",
"designers": 4750,
"respondents": 18439,
"totalUsers": 21624
},
{
"reportDate": "2022-06-05",
"designers": 467,
"respondents": 1726,
"totalUsers": 2103
},
{
"reportDate": "2022-06-04",
"designers": 476,
"respondents": 1692,
"totalUsers": 2086
},
{
"reportDate": "2022-06-03",
"designers": 3853,
"respondents": 14491,
"totalUsers": 17185
},
{
"reportDate": "2022-06-02",
"designers": 4657,
"respondents": 19798,
"totalUsers": 22930
}
]
}
]
}