Zoom API Data Model
Report_UsersUsers |
Retrieve hosts reportRetrieve active or inactive hosts report for a specified period
Catalog: Zoom
Schema: Reports
This is a read-only table function. The Zoom API may not support changing the data or the Invantive SQL driver for Zoom does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Zoom API.
Select Zoom API URL: /report/users
Insert Zoom API URL: /report/users
Update Zoom API URL: /report/users
Delete Zoom API URL: /report/users
Field Selection Method: NotRequired
Base Path: users[*]
Select Zoom API Operation: get /report/users
Parameters of Table Function
The following parameters can be used to control the behaviour of the table function Report_UsersUsers. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be treated using their default values.
Value specification by position is done by listing all values from the first to the last needed value. For example with `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.
Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.
Name |
Data Type |
Required |
Default Value |
Documentation |
|---|---|---|---|---|
from |
datetime |
☑ |
|
Start Date |
page_number |
int64 |
☐ |
1 |
Current page number of returned records |
page_size |
int64 |
☐ |
30 |
The number of records returned within a single API call |
to |
datetime |
☑ |
|
End Date |
type |
string |
☐ |
|
Active hosts or inactive hosts (Values: active, inactive) |
Table Function Columns
The columns of the table function Report_UsersUsers are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
dept |
string |
|
☐ |
User department |
string |
|
☐ |
User email |
|
from |
datetime |
|
☐ |
Start date for this report |
id |
guid |
|
☐ |
User ID |
meeting_minutes |
int64 |
|
☐ |
Number of meeting minutes for user |
meetings |
int64 |
|
☐ |
Number of meetings for user |
page_count |
int64 |
|
☐ |
The number of items returned on this page |
page_number |
int64 |
|
☐ |
The page number of current results |
page_size |
int64 |
|
☐ |
The number of records returned within a single API call |
participants |
int64 |
|
☐ |
Number of participants in meetings for user |
to |
datetime |
|
☐ |
End date for this report |
total_meeting_minutes |
int64 |
|
☐ |
Number of meeting minutes for this range |
total_meetings |
int64 |
|
☐ |
Number of meetings for this range |
total_participants |
int64 |
|
☐ |
Number of participants for this range |
total_records |
int64 |
|
☐ |
The number of all records available across pages |
type |
int64 |
|
☐ |
User type |
user_name |
string |
|
☐ |
User display name |
16-06-2022 17:21 Version 22.1.46-BETA+3385
