| Title: | Connect to Your 'Zoom' Data |
|---|---|
| Description: | Facilitates making a connection to the 'Zoom' API and executing various queries. You can use it to get data on 'Zoom' webinars and 'Zoom' meetings. The 'Zoom' documentation is available at <https://developers.zoom.us/docs/api/>. This package is not supported by 'Zoom' (owner of the software). |
| Authors: | Chris Umphlett [aut, cre] |
| Maintainer: | Chris Umphlett <[email protected]> |
| License: | CC0 |
| Version: | 0.3.0.9000 |
| Built: | 2024-11-22 05:22:29 UTC |
| Source: | https://github.com/chrisumphlett/zoomr |
Get all users in a zoom account. The user id is required to get a list of webinars hosted by a particular user.
get_account_users(account_id, client_id, client_secret)get_account_users(account_id, client_id, client_secret)
account_id |
Account Id granted by the Zoom developer app. |
client_id |
Client Id granted by the Zoom developer app. |
client_secret |
Client secret granted by the Zoom developer app. |
A data frame with the list of all users in the account.
See <https://marketplace.zoom.us/docs/api-reference/zoom-api/> for documentation on the Zoom API.
## Not run: dat <- get_account_users(your_account_id, your_client_id, your_client_secret) ## End(Not run)## Not run: dat <- get_account_users(your_account_id, your_client_id, your_client_secret) ## End(Not run)
Get the list of attendees who were also panelists from a single webinar.
get_panelists(webinar_id, account_id, client_id, client_secret)get_panelists(webinar_id, account_id, client_id, client_secret)
webinar_id |
Zoom Webinar Id, typically an 11 digit number. |
account_id |
Account Id granted by the Zoom developer app. |
client_id |
Client Id granted by the Zoom developer app. |
client_secret |
Client secret granted by the Zoom developer app. |
A data frame with the list of panelists from that webinar.
See <https://marketplace.zoom.us/docs/api-reference/zoom-api/> for documentation on the Zoom API.
## Not run: dat <- get_webinar_panelists(webinar_id = "99911112222", your_account_id, your_client_id, your_client_secret) ## End(Not run)## Not run: dat <- get_webinar_panelists(webinar_id = "99911112222", your_account_id, your_client_id, your_client_secret) ## End(Not run)
Get registration question answers from all registrants for a single webinar.
get_registration_questions( webinar_id, account_id, client_id, client_secret, registrant_status = c("approved") )get_registration_questions( webinar_id, account_id, client_id, client_secret, registrant_status = c("approved") )
webinar_id |
Zoom Webinar Id, typically an 11 digit number. |
account_id |
Account Id granted by the Zoom developer app. |
client_id |
Client Id granted by the Zoom developer app. |
client_secret |
Client secret granted by the Zoom developer app. |
registrant_status |
One or more of "approved", "pending", or "denied". Default is "approved" only. |
A data frame with the registration question answers.
See <https://marketplace.zoom.us/docs/api-reference/zoom-api/> for documentation on the Zoom API.
## Not run: dat <- get_registration_questions(webinar_id = "99911112222", your_account_id, your_client_id, your_client_secret, c("approved", "denied", "pending")) ## End(Not run)## Not run: dat <- get_registration_questions(webinar_id = "99911112222", your_account_id, your_client_id, your_client_secret, c("approved", "denied", "pending")) ## End(Not run)
Get a summary of registrations and visitors by tracking source for a specific webinar.
get_tracking_sources(webinar_id, account_id, client_id, client_secret)get_tracking_sources(webinar_id, account_id, client_id, client_secret)
webinar_id |
Zoom Webinar Id, typically an 11 digit number. |
account_id |
Account Id granted by the Zoom developer app. |
client_id |
Client Id granted by the Zoom developer app. |
client_secret |
Client secret granted by the Zoom developer app. |
A data frame with the list of panelists from that webinar.
See <https://marketplace.zoom.us/docs/api-reference/zoom-api/> for documentation on the Zoom API.
## Not run: dat <- get_tracking_sources(webinar_id = "99911112222", your_account_id, your_client_id, your_client_secret) ## End(Not run)## Not run: dat <- get_tracking_sources(webinar_id = "99911112222", your_account_id, your_client_id, your_client_secret) ## End(Not run)
Get metadata about a single webinar.
get_webinar_details(webinar_id, account_id, client_id, client_secret)get_webinar_details(webinar_id, account_id, client_id, client_secret)
webinar_id |
Zoom Webinar Id, typically an 11 digit number. |
account_id |
Account Id granted by the Zoom developer app. |
client_id |
Client Id granted by the Zoom developer app. |
client_secret |
Client secret granted by the Zoom developer app. |
A data frame with the metadata about a webinar.
See <https://marketplace.zoom.us/docs/api-reference/zoom-api/> for documentation on the Zoom API.
## Not run: dat <- get_webinar_details(webinar_id = "99911112222", your_account_id, your_client_id, your_client_secret) ## End(Not run)## Not run: dat <- get_webinar_details(webinar_id = "99911112222", your_account_id, your_client_id, your_client_secret) ## End(Not run)
Get participant info about a single webinar.
get_webinar_participants(webinar_id, account_id, client_id, client_secret)get_webinar_participants(webinar_id, account_id, client_id, client_secret)
webinar_id |
Zoom Webinar Id, typically an 11 digit number. |
account_id |
Account Id granted by the Zoom developer app. |
client_id |
Client Id granted by the Zoom developer app. |
client_secret |
Client secret granted by the Zoom developer app. |
A data frame with data on each participant at a webinar.
See <https://marketplace.zoom.us/docs/api-reference/zoom-api/> for documentation on the Zoom API.
## Not run: dat <- get_webinar_participants(webinar_id = "99911112222", your_account_id, your_client_id, your_client_secret) ## End(Not run)## Not run: dat <- get_webinar_participants(webinar_id = "99911112222", your_account_id, your_client_id, your_client_secret) ## End(Not run)
Get the polls summary from a single webinar.
get_webinar_polls(webinar_id, account_id, client_id, client_secret)get_webinar_polls(webinar_id, account_id, client_id, client_secret)
webinar_id |
Zoom Webinar Id, typically an 11 digit number. |
account_id |
Account Id granted by the Zoom developer app. |
client_id |
Client Id granted by the Zoom developer app. |
client_secret |
Client secret granted by the Zoom developer app. |
A data frame with poll results from a webinar.
See <https://marketplace.zoom.us/docs/api-reference/zoom-api/> for documentation on the Zoom API.
## Not run: dat <- get_webinar_polls(webinar_id = "99911112222", your_account_id, your_client_id, your_client_secret) ## End(Not run)## Not run: dat <- get_webinar_polls(webinar_id = "99911112222", your_account_id, your_client_id, your_client_secret) ## End(Not run)
Get the Q&A summary from a single webinar.
get_webinar_qanda(webinar_id, account_id, client_id, client_secret)get_webinar_qanda(webinar_id, account_id, client_id, client_secret)
webinar_id |
Zoom Webinar Id, typically an 11 digit number. |
account_id |
Account Id granted by the Zoom developer app. |
client_id |
Client Id granted by the Zoom developer app. |
client_secret |
Client secret granted by the Zoom developer app. |
A data frame with all of the Q&A data from a webinar.
See <https://marketplace.zoom.us/docs/api-reference/zoom-api/> for documentation on the Zoom API.
## Not run: dat <- get_webinar_qanda(webinar_id = "99911112222", your_account_id, your_client_id, your_client_secret) ## End(Not run)## Not run: dat <- get_webinar_qanda(webinar_id = "99911112222", your_account_id, your_client_id, your_client_secret) ## End(Not run)
Get registrant info about a single webinar.
get_webinar_registrants( webinar_id, account_id, client_id, client_secret, registrant_status = c("approved") )get_webinar_registrants( webinar_id, account_id, client_id, client_secret, registrant_status = c("approved") )
webinar_id |
Zoom Webinar Id, typically an 11 digit number. |
account_id |
Account Id granted by the Zoom developer app. |
client_id |
Client Id granted by the Zoom developer app. |
client_secret |
Client secret granted by the Zoom developer app. |
registrant_status |
One or more of "approved", "pending", or "denied". Default is "approved" only. |
A data frame with data on all the registrants for a webinar.
See <https://marketplace.zoom.us/docs/api-reference/zoom-api/> for documentation on the Zoom API.
## Not run: dat <- get_webinar_registrants(webinar_id = "99911112222", your_account_id, your_client_id, your_client_secret, c("approved", "denied", "pending")) ## End(Not run)## Not run: dat <- get_webinar_registrants(webinar_id = "99911112222", your_account_id, your_client_id, your_client_secret, c("approved", "denied", "pending")) ## End(Not run)
Get list of webinars for a User. This is used to get the webinar Id's to pass into other functions.
list_webinars(user_id, account_id, client_id, client_secret)list_webinars(user_id, account_id, client_id, client_secret)
user_id |
Zoom User Id. |
account_id |
Account Id granted by the Zoom developer app. |
client_id |
Client Id granted by the Zoom developer app. |
client_secret |
Client secret granted by the Zoom developer app. |
A data frame with all of the webinars hosted by a specific user.
See <https://marketplace.zoom.us/docs/api-reference/zoom-api/> for documentation on the Zoom API.
## Not run: dat <- get_webinar_details(user_id = "user_id_string", your_account_id, your_client_id, your_client_secret) ## End(Not run)## Not run: dat <- get_webinar_details(user_id = "user_id_string", your_account_id, your_client_id, your_client_secret) ## End(Not run)