Repository files navigation

Connect to your 'Zoom' reporting data

zoom facilitates making a connection to the Zoom Reporting API. Currently it is used for getting data on webinars. Many other API endpoints are available, this documentation is found athttps://marketplace.zoom.us/docs/api-reference/zoom-api/.

The development version can be installed from GitHub:remotes::install_github("chrisumphlett/zoomr").

A server-to-server app must be created within your Zoom account first. This will provide an Account Id, Client Id, and Client Secret. These are required for all of the api call functions in this package in order to generate an access token.

An expected workflow starts with looking up the user Id's for hosts. This is done with theget_account_users() function, which produces a data frame with user data. The user Id is then used in both webinar and meeting functions.

Once you have a user Id, uselist_webinars() to find the webinars hosted by the user in the last 90 days. Once you have a webinar Id, these functions are available:

• get_webinar_details() - More information on the webinar such as the topic, start and end time, duration, and number of participants.
• get_webinar_registrants() - Data on who registered for a webinar.
• get_registration_questions() - Their answers to questions you asked when they registered.
• get_webinar_participants() - Data on who attended the webinar.
• get_panelists() - Figure out which of your participants were actually panelists.
• get_webinar_polls() andget_webinar_qanda() - Poll and Q&A data from the webinar.Post-webinar survey data is not available in the Zoom API as of 2022-09-28.
• get_tracking_sources() - Get a summary of registrations and visitors by tracking source for a specific webinar.

Uselist_meetings() to find meetings hosted by the user. Once you have a meeting Id, these functions are available:

• get_meeting_details() - Get metadata about a single meeting including participant count, duration, and other meeting statistics.
• get_meeting_participants() - Get participant info about a single meeting or all instances of a recurring meeting.
  • For recurring meetings, useinclude_all_instances = TRUE to get participants from all occurrences