A user is considered to be an active host during the month specified in the "from" and "to" range, if the user has hosted at least one meeting during this period. If the user didn't host any meetings during this period, the user is considered to be inactive.The Active Hosts report displays a list of meetings, participants, and meeting minutes for a specific time range, up to one month. The month should fall within the last six months.The Inactive Hosts report pulls a list of users who were not active during a specific period of time. Use this API to retrieve an active or inactive host report for a specified period of time. The time range for the report is limited to a month and the month should fall under the past six months. You can specify the type of report and date range using the query parameters.**Scopes:** report:read:admin ** Rate Limit Label https://marketplace.zoom.us/docs/apireference/ratelimits#ratelimits :** Heavy**Prerequisites:*** Pro or higher plan.

getActiveInactiveHostReports(
  type = NULL,
  from,
  to,
  page_size = NULL,
  page_number = NULL,
  return_response = F
)

Arguments

type

Active or inactive hosts.active Active hosts. inactive Inactive hosts.

from

Start date in 'yyyymmdd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.

to

End date.

page_size

The number of records returned within a single API call.

page_number

**Deprecated** This field has been deprecated and we will stop supporting it completely in a future release. Please use "next_page_token" for pagination instead of this field.The page number of the current page in the returned records.

return_response

Whether to return the response instead of the response content. Defaults to FALSE.