Zoom Public API Documentation
Event Attendance Report
GET {{baseUrl}}/zoom_events/events/:eventId/reports/event_attendance?page_size=30&next_page_token=<string>
Use this API to retrieve event attendance report. Scopes: Rate Limit Label: zoom_events_reports:read:adminzoom_events_reports:readHEAVY
Body
PARAM
| Key | Datatype | Required | Description |
page_size
|
number | The number of records returned in a single API call. Max 300 | |
next_page_token
|
string | The next page token paginates through a set of large results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"total_records": "<number>",
"next_page_token": "<string>",
"attendees": [
{
"display_name": "<string>",
"email": "<string>",
"opt_in_marketing": 0,
"marketing_consent_prechecked": 1,
"event_attendance": "absent",
"attendance_type": [
"hybrid",
"in_person"
],
"lobby_attendance": "absent",
"lobby_chat_sent": "<number>",
"survey_taken": "<number>",
"total_sessions_joined": "<number>",
"number_of_tickets": "<number>",
"role": "<string>",
"tickets": [
{
"ticket_type_name": "<string>",
"ticket_type_id": "<string>",
"ticket_id": "<string>",
"questions": [
{
"title": "<string>",
"answer": "<string>"
},
{
"title": "<string>",
"answer": "<string>"
}
]
},
{
"ticket_type_name": "<string>",
"ticket_type_id": "<string>",
"ticket_id": "<string>",
"questions": [
{
"title": "<string>",
"answer": "<string>"
},
{
"title": "<string>",
"answer": "<string>"
}
]
}
],
"session_attendance": [
{
"session_id": "<string>",
"session_name": "<string>",
"session_attendance": "attended",
"duration_spent_in_session": "<number>",
"chat_messages_sent": "<number>",
"connection_made": "<number>",
"material_download": "<boolean>",
"recording_view": "<boolean>",
"live_stream_view": "<boolean>",
"recording_view_duration": "<number>",
"live_streaming_view_duration": "<number>"
},
{
"session_id": "<string>",
"session_name": "<string>",
"session_attendance": "absent",
"duration_spent_in_session": "<number>",
"chat_messages_sent": "<number>",
"connection_made": "<number>",
"material_download": "<boolean>",
"recording_view": "<boolean>",
"live_stream_view": "<boolean>",
"recording_view_duration": "<number>",
"live_streaming_view_duration": "<number>"
}
],
"profile_created": "<boolean>",
"personal_chats": "<number>"
},
{
"display_name": "<string>",
"email": "<string>",
"opt_in_marketing": 1,
"marketing_consent_prechecked": 0,
"event_attendance": "absent",
"attendance_type": [
"in_person",
"hybrid"
],
"lobby_attendance": "attended",
"lobby_chat_sent": "<number>",
"survey_taken": "<number>",
"total_sessions_joined": "<number>",
"number_of_tickets": "<number>",
"role": "<string>",
"tickets": [
{
"ticket_type_name": "<string>",
"ticket_type_id": "<string>",
"ticket_id": "<string>",
"questions": [
{
"title": "<string>",
"answer": "<string>"
},
{
"title": "<string>",
"answer": "<string>"
}
]
},
{
"ticket_type_name": "<string>",
"ticket_type_id": "<string>",
"ticket_id": "<string>",
"questions": [
{
"title": "<string>",
"answer": "<string>"
},
{
"title": "<string>",
"answer": "<string>"
}
]
}
],
"session_attendance": [
{
"session_id": "<string>",
"session_name": "<string>",
"session_attendance": "attended",
"duration_spent_in_session": "<number>",
"chat_messages_sent": "<number>",
"connection_made": "<number>",
"material_download": "<boolean>",
"recording_view": "<boolean>",
"live_stream_view": "<boolean>",
"recording_view_duration": "<number>",
"live_streaming_view_duration": "<number>"
},
{
"session_id": "<string>",
"session_name": "<string>",
"session_attendance": "attended",
"duration_spent_in_session": "<number>",
"chat_messages_sent": "<number>",
"connection_made": "<number>",
"material_download": "<boolean>",
"recording_view": "<boolean>",
"live_stream_view": "<boolean>",
"recording_view_duration": "<number>",
"live_streaming_view_duration": "<number>"
}
],
"profile_created": "<boolean>",
"personal_chats": "<number>"
}
]
} |
Curl
curl -X GET 'https://api.zoom.us/v2/zoom_events/events/:eventId/reports/event_attendance?page_size=30&next_page_token=<string>?page_size=30&next_page_token=<string>' -H 'Accept: application/json'
ENDPOINTS