Get active/inactive host reports

GET {{baseUrl}}/report/users?type=inactive&from=<date>&to=<date>&page_size=30&page_number=1&next_page_token=<string>&group_id=<string>

Retrieve a host report for a specified period of time within the last six months.
The report time range is limited to a month.

You can specify the type of report and date range using the query parameters.

  • The Active Hosts report displays a list of meetings, participants, and meeting minutes. An active host is defined as any user who has hosted at least one meeting during the during the month specified in the from and to range.

  • The Inactive Hosts report pulls a list of users who were not active during a specific period of time.
    An inactive host is defined as any user who has not hosted any meetings during the specified period of time for the report. to be inactive.

Prerequisites:

  • Pro or higher plan.

Scopes: report:read:admin

Rate Limit Label: HEAVY

Request Params

KeyDatatypeRequiredDescription
typestringActive or inactive hosts.
active - Active hosts.
inactive - Inactive hosts.
fromstring(Required) Start date in 'yyyy-mm-dd' 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.
tostring(Required) End date.
page_sizenumberThe number of records returned within a single API call.
page_numbernumberThe page number of the current page in the returned records.
next_page_tokenstringThe next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
group_idstringThe group ID. To get a group ID, use the List groups API.

Note: The API response will only contain users who are members of the queried group ID. |

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK