Skip to content

Commit 18114e8

Browse files
authored
Merge pull request #25392 from microsoftgraph/mkuninty-serviceActivityForScenarioHealth
Initial draft to onboard M365 Monitoring APIs documentation
2 parents c31ac32 + f5c96cd commit 18114e8

26 files changed

+2262
-3
lines changed
Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
---
2+
title: "serviceActivity: getActiveUserMetricsForDesktopMailByReadEmail"
3+
description: "Get all the active usage based on the number of users who successfully read emails using desktop mail apps."
4+
author: "mkuninty"
5+
ms.localizationpriority: medium
6+
ms.subservice: "m365-monitoring-service"
7+
doc_type: apiPageType
8+
ms.date: 12/02/2024
9+
---
10+
11+
# serviceActivity: getActiveUserMetricsForDesktopMailByReadEmail
12+
Namespace: microsoft.graph
13+
14+
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
15+
16+
Get all the active usage based on the number of users who successfully read emails using desktop mail apps.
17+
18+
## Permissions
19+
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](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
20+
21+
|Permission type|Least privileged permissions|Higher privileged permissions|
22+
|:---|:---|:---|
23+
|Delegated (work or school account)|ServiceActivity-Exchange.Read.All|Not available.|
24+
|Delegated (personal Microsoft account)|Not supported.|Not supported.|
25+
|Application|ServiceActivity-Exchange.Read.All|Not available.|
26+
27+
## HTTP request
28+
29+
<!-- {
30+
"blockType": "ignored"
31+
}
32+
-->
33+
``` http
34+
GET /reports/serviceActivity/getActiveUserMetricsForDesktopMailByReadEmail
35+
```
36+
37+
## Function parameters
38+
In the request URL, provide the following query parameters with values.
39+
40+
|Parameter|Type|Description|
41+
|:---|:---|:---|
42+
|aggregationIntervalInMinutes|Int32|Aggregation interval in minutes. The default value is `15`, which sets the data to be aggregated into 15-minute sets. Allowed values are `5`, `10`, `15`, and `30`. Optional.|
43+
|exclusiveIntervalEndDateTime|DateTimeOffset|The ending date and time in UTC. Required.|
44+
|inclusiveIntervalStartDateTime|DateTimeOffset|The starting date and time in UTC. The earliest start time allowed is 30 days in the past. Required.|
45+
46+
## Request headers
47+
|Name|Description|
48+
|:---|:---|
49+
|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
50+
51+
## Request body
52+
Don't supply a request body for this method.
53+
54+
## Response
55+
56+
If successful, this function returns a `200 OK` response code and a [serviceActivityValueMetric](../resources/serviceactivityvaluemetric.md) collection in the response body.
57+
58+
## Examples
59+
60+
### Request
61+
The following example shows a request.
62+
63+
<!-- {
64+
"blockType": "request",
65+
"name": "serviceactivitythis.getactiveusermetricsfordesktopmailbyreademail"
66+
}
67+
-->
68+
``` http
69+
GET https://graph.microsoft.com/beta/reports/serviceActivity/getActiveUserMetricsForDesktopMailByReadEmail(inclusiveIntervalStartDateTime=2024-10-02T10:30:00Z,exclusiveIntervalEndDateTime=2024-10-02T10:59:59Z,aggregationIntervalInMinutes=10)
70+
```
71+
72+
### Response
73+
The following example shows the response.
74+
>**Note:** The response object shown here might be shortened for readability.
75+
<!-- {
76+
"blockType": "response",
77+
"truncated": true,
78+
"@odata.type": "Collection(microsoft.graph.serviceActivityValueMetric)"
79+
}
80+
-->
81+
``` http
82+
HTTP/1.1 200 OK
83+
Content-Type: application/json
84+
85+
{
86+
"@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(microsoft.graph.serviceActivityValueMetric)",
87+
"value": [
88+
{
89+
"intervalStartDateTime": "2024-10-02T10:30:00Z",
90+
"value": 6880
91+
},
92+
{
93+
"intervalStartDateTime": "2024-10-02T10:40:00Z",
94+
"value": 6480
95+
}
96+
]
97+
}
98+
```
Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
---
2+
title: "serviceActivity: getActiveUserMetricsForEmailByModernAuthentication"
3+
description: "Get all the active usage based on the number of users who signed in with modern authentication across all email apps."
4+
author: "mkuninty"
5+
ms.localizationpriority: medium
6+
ms.subservice: "m365-monitoring-service"
7+
doc_type: apiPageType
8+
ms.date: 12/02/2024
9+
---
10+
11+
# serviceActivity: getActiveUserMetricsForEmailByModernAuthentication
12+
Namespace: microsoft.graph
13+
14+
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
15+
16+
Get all the active usage based on the number of users who signed in with modern authentication across all email apps.
17+
18+
## Permissions
19+
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](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
20+
21+
|Permission type|Least privileged permissions|Higher privileged permissions|
22+
|:---|:---|:---|
23+
|Delegated (work or school account)|ServiceActivity-Exchange.Read.All|Not available.|
24+
|Delegated (personal Microsoft account)|Not supported.|Not supported.|
25+
|Application|ServiceActivity-Exchange.Read.All|Not available.|
26+
27+
## HTTP request
28+
29+
<!-- {
30+
"blockType": "ignored"
31+
}
32+
-->
33+
``` http
34+
GET /reports/serviceActivity/getActiveUserMetricsForEmailByModernAuthentication
35+
```
36+
37+
## Function parameters
38+
In the request URL, provide the following query parameters with values.
39+
40+
|Parameter|Type|Description|
41+
|:---|:---|:---|
42+
|aggregationIntervalInMinutes|Int32|Aggregation interval in minutes. The default value is `15`, which sets the data to be aggregated into 15-minute sets. Allowed values are `5`, `10`, `15`, and `30`. Optional.|
43+
|exclusiveIntervalEndDateTime|DateTimeOffset|The ending date and time in UTC. Required.|
44+
|inclusiveIntervalStartDateTime|DateTimeOffset|The starting date and time in UTC. The earliest start time allowed is 30 days in the past. Required.|
45+
46+
## Request headers
47+
|Name|Description|
48+
|:---|:---|
49+
|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
50+
51+
## Request body
52+
Don't supply a request body for this method.
53+
54+
## Response
55+
56+
If successful, this function returns a `200 OK` response code and a [serviceActivityValueMetric](../resources/serviceactivityvaluemetric.md) collection in the response body.
57+
58+
## Examples
59+
60+
### Request
61+
The following example shows a request.
62+
63+
<!-- {
64+
"blockType": "request",
65+
"name": "serviceactivitythis.getactiveusermetricsforemailbymodernauthentication"
66+
}
67+
-->
68+
``` http
69+
GET https://graph.microsoft.com/beta/reports/serviceActivity/getActiveUserMetricsForEmailByModernAuthentication(inclusiveIntervalStartDateTime=2024-10-02T10:30:00Z,exclusiveIntervalEndDateTime=2024-10-02T10:59:59Z,aggregationIntervalInMinutes=10)
70+
```
71+
72+
### Response
73+
The following example shows the response.
74+
>**Note:** The response object shown here might be shortened for readability.
75+
<!-- {
76+
"blockType": "response",
77+
"truncated": true,
78+
"@odata.type": "Collection(microsoft.graph.serviceActivityValueMetric)"
79+
}
80+
-->
81+
``` http
82+
HTTP/1.1 200 OK
83+
Content-Type: application/json
84+
85+
{
86+
"@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(microsoft.graph.serviceActivityValueMetric)",
87+
"value": [
88+
{
89+
"intervalStartDateTime": "2024-10-02T10:30:00Z",
90+
"value": 200715
91+
},
92+
{
93+
"intervalStartDateTime": "2024-10-02T10:40:00Z",
94+
"value": 192954
95+
}
96+
]
97+
}
98+
```
Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
---
2+
title: "serviceActivity: getActiveUserMetricsForExcelWeb"
3+
description: "Get all the active usage based on the number of active users who open or save Excel for the web."
4+
author: "mkuninty"
5+
ms.localizationpriority: medium
6+
ms.subservice: "m365-monitoring-service"
7+
doc_type: apiPageType
8+
ms.date: 12/02/2024
9+
---
10+
11+
# serviceActivity: getActiveUserMetricsForExcelWeb
12+
Namespace: microsoft.graph
13+
14+
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
15+
16+
Get all the active usage based on the number of active users who open or save Excel for the web.
17+
18+
## Permissions
19+
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](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
20+
21+
|Permission type|Least privileged permissions|Higher privileged permissions|
22+
|:---|:---|:---|
23+
|Delegated (work or school account)|ServiceActivity-Microsoft365Web.Read.All|Not available.|
24+
|Delegated (personal Microsoft account)|Not supported.|Not supported.|
25+
|Application|ServiceActivity-Microsoft365Web.Read.All|Not available.|
26+
27+
## HTTP request
28+
29+
<!-- {
30+
"blockType": "ignored"
31+
}
32+
-->
33+
``` http
34+
GET /reports/serviceActivity/getActiveUserMetricsForExcelWeb
35+
```
36+
37+
## Function parameters
38+
In the request URL, provide the following query parameters with values.
39+
40+
|Parameter|Type|Description|
41+
|:---|:---|:---|
42+
|aggregationIntervalInMinutes|Int32|Aggregation interval in minutes. The default value is `15`, which sets the data to be aggregated into 15-minute sets. Allowed values are `5`, `10`, `15`, and `30`. Optional.|
43+
|exclusiveIntervalEndDateTime|DateTimeOffset|The ending date and time in UTC. Required.|
44+
|inclusiveIntervalStartDateTime|DateTimeOffset|The starting date and time in UTC. The earliest start time allowed is 30 days in the past. Required.|
45+
46+
## Request headers
47+
|Name|Description|
48+
|:---|:---|
49+
|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
50+
51+
## Request body
52+
Don't supply a request body for this method.
53+
54+
## Response
55+
56+
If successful, this function returns a `200 OK` response code and a [serviceActivityValueMetric](../resources/serviceactivityvaluemetric.md) collection in the response body.
57+
58+
## Examples
59+
60+
### Request
61+
The following example shows a request.
62+
63+
<!-- {
64+
"blockType": "request",
65+
"name": "serviceactivitythis.getactiveusermetricsforexcelweb"
66+
}
67+
-->
68+
``` http
69+
GET https://graph.microsoft.com/beta/reports/serviceActivity/getActiveUserMetricsForExcelWeb(inclusiveIntervalStartDateTime=2024-10-02T10:30:00Z,exclusiveIntervalEndDateTime=2024-10-02T10:59:59Z,aggregationIntervalInMinutes=10)
70+
```
71+
72+
### Response
73+
The following example shows the response.
74+
>**Note:** The response object shown here might be shortened for readability.
75+
<!-- {
76+
"blockType": "response",
77+
"truncated": true,
78+
"@odata.type": "Collection(microsoft.graph.serviceActivityValueMetric)"
79+
}
80+
-->
81+
``` http
82+
HTTP/1.1 200 OK
83+
Content-Type: application/json
84+
85+
{
86+
"@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(microsoft.graph.serviceActivityValueMetric)",
87+
"value": [
88+
{
89+
"intervalStartDateTime": "2024-10-02T10:30:00Z",
90+
"value": 1783
91+
},
92+
{
93+
"intervalStartDateTime": "2024-10-02T10:40:00Z",
94+
"value": 1674
95+
}
96+
]
97+
}
98+
```
Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
---
2+
title: "serviceActivity: getActiveUserMetricsForiOSOrAndroidMailByReadEmail"
3+
description: "Get all the active usage based on the number of users who successfully read emails using iOS or Android mail apps."
4+
author: "mkuninty"
5+
ms.localizationpriority: medium
6+
ms.subservice: "m365-monitoring-service"
7+
doc_type: apiPageType
8+
ms.date: 12/02/2024
9+
---
10+
11+
# serviceActivity: getActiveUserMetricsForiOSOrAndroidMailByReadEmail
12+
Namespace: microsoft.graph
13+
14+
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
15+
16+
Get all the active usage based on the number of users who successfully read emails using iOS or Android mail apps.
17+
18+
## Permissions
19+
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](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
20+
21+
|Permission type|Least privileged permissions|Higher privileged permissions|
22+
|:---|:---|:---|
23+
|Delegated (work or school account)|ServiceActivity-Exchange.Read.All|Not available.|
24+
|Delegated (personal Microsoft account)|Not supported.|Not supported.|
25+
|Application|ServiceActivity-Exchange.Read.All|Not available.|
26+
27+
## HTTP request
28+
29+
<!-- {
30+
"blockType": "ignored"
31+
}
32+
-->
33+
``` http
34+
GET /reports/serviceActivity/getActiveUserMetricsForiOSOrAndroidMailByReadEmail
35+
```
36+
37+
## Function parameters
38+
In the request URL, provide the following query parameters with values.
39+
40+
|Parameter|Type|Description|
41+
|:---|:---|:---|
42+
|aggregationIntervalInMinutes|Int32|Aggregation interval in minutes. The default value is `15`, which sets the data to be aggregated into 15-minute sets. Allowed values are `5`, `10`, `15`, and `30`. Optional.|
43+
|exclusiveIntervalEndDateTime|DateTimeOffset|The ending date and time in UTC. Required.|
44+
|inclusiveIntervalStartDateTime|DateTimeOffset|The starting date and time in UTC. The earliest start time allowed is 30 days in the past. Required.|
45+
46+
## Request headers
47+
|Name|Description|
48+
|:---|:---|
49+
|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
50+
51+
## Request body
52+
Don't supply a request body for this method.
53+
54+
## Response
55+
56+
If successful, this function returns a `200 OK` response code and a [serviceActivityValueMetric](../resources/serviceactivityvaluemetric.md) collection in the response body.
57+
58+
## Examples
59+
60+
### Request
61+
The following example shows a request.
62+
63+
<!-- {
64+
"blockType": "request",
65+
"name": "serviceactivitythis.getactiveusermetricsforiosorandroidmailbyreademail"
66+
}
67+
-->
68+
``` http
69+
GET https://graph.microsoft.com/beta/reports/serviceActivity/getActiveUserMetricsForiOSOrAndroidMailByReadEmail(inclusiveIntervalStartDateTime=2024-10-02T10:30:00Z,exclusiveIntervalEndDateTime=2024-10-02T10:59:59Z,aggregationIntervalInMinutes=10)
70+
```
71+
72+
### Response
73+
The following example shows the response.
74+
>**Note:** The response object shown here might be shortened for readability.
75+
<!-- {
76+
"blockType": "response",
77+
"truncated": true,
78+
"@odata.type": "Collection(microsoft.graph.serviceActivityValueMetric)"
79+
}
80+
-->
81+
``` http
82+
HTTP/1.1 200 OK
83+
Content-Type: application/json
84+
85+
{
86+
"@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(microsoft.graph.serviceActivityValueMetric)",
87+
"value": [
88+
{
89+
"intervalStartDateTime": "2024-10-02T10:30:00Z",
90+
"value": 132
91+
},
92+
{
93+
"intervalStartDateTime": "2024-10-02T10:40:00Z",
94+
"value": 154
95+
}
96+
]
97+
}
98+
```

0 commit comments

Comments
 (0)