Get meetingAttendanceReport
Namespace: microsoft.graph
Get the meetingAttendanceReport for an onlineMeeting. Each time an online meeting ends, an attendance report will be generated for that session.
Warning
This method does not support channel meetings.
Permissions
One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.
Permission type | Permissions (from least to most privileged) |
---|---|
Delegated (work or school account) | OnlineMeetingArtifact.Read.All |
Delegated (personal Microsoft account) | Not supported. |
Application | OnlineMeetingArtifact.Read.All |
To use application permission for this API, tenant administrators must create an application access policy and grant it to a user. This authorizes the app configured in the policy to fetch online meetings and/or online meeting artifacts on behalf of that user (with the user ID specified in the request path). For more details, see Allow applications to access online meetings on behalf of a user.
HTTP request
To get an attendance report by ID with delegated (/me
) and app (/users/{userId}
) permission:
GET /me/onlineMeetings/{meetingId}/attendanceReports/{reportId}
GET /users/{userId}/onlineMeetings/{meetingId}/attendanceReports/{reportId}
Tip
userId
is the object ID of a user in Azure user management portal. For more details, see Allow applications to access online meetings on behalf of a user.meetingId
is the id of an onlineMeeting object.reportId
is the id of an meetingAttendanceReport object.
Caution
- The attendanceRecords property does not return information about a breakout room.
Optional query parameters
This method supports the OData query parameters to help customize the response.
Tip
The attendanceRecords property is a navigation property that is not returned by default. To retrieve attendanceRecords in line, use the $expand=attendanceRecords
query option as shown in the example.
Request headers
Name | Description |
---|---|
Authorization | Bearer {token}. Required. |
Request body
Do not supply a request body for this method.
Response
If successful, this method returns a 200 OK
response code and a meetingAttendanceReport object in the response body.
Example
The following example shows how to get the attendance report for an online meeting with delegated permission.
Request
GET https://graph.microsoft.com/v1.0/me/onlineMeetings/MSpkYzE3Njc0Yy04MWQ5LTRhZGItYmZ/attendanceReports/c9b6db1c-d5eb-427d-a5c0-20088d9b22d7?$expand=attendanceRecords
Response
Note: The response object shown here might be shortened for readability.
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('16664f75-11dc-4870-bec6-38c1aaa81431')/onlineMeetings('MSpkYzE3Njc0Yy04MWQ5LTRhZGItYmZ')/attendanceReports('c9b6db1c-d5eb-427d-a5c0-20088d9b22d7')",
"id": "c9b6db1c-d5eb-427d-a5c0-20088d9b22d7",
"totalParticipantCount": 1,
"meetingStartDateTime": "2021-10-05T04:38:23.945Z",
"meetingEndDateTime": "2021-10-05T04:43:49.77Z",
"attendanceRecords": [
{
"emailAddress": "frederick.cormier@contoso.com",
"totalAttendanceInSeconds": 1152,
"role": "Presenter",
"identity": {
"id": "dc17674c-81d9-4adb-bfb2-8f6a442e4623",
"displayName": "Frederick Cormier",
"tenantId": null
},
"attendanceIntervals": [
{
"joinDateTime": "2021-03-16T18:59:52.2782182Z",
"leaveDateTime": "2021-03-16T19:06:47.7218491Z",
"durationInSeconds": 415
},
{
"joinDateTime": "2021-03-16T19:09:23.9834702Z",
"leaveDateTime": "2021-03-16T19:16:31.1381195Z",
"durationInSeconds": 427
},
{
"joinDateTime": "2021-03-16T19:20:27.7094382Z",
"leaveDateTime": "2021-03-16T19:25:37.7121956Z",
"durationInSeconds": 310
}
]
}
]
}
Feedback
Submit and view feedback for