Metrics_MeetingsMeetings |
List meetingsList live meetings or past meetings for a specified period
Catalog: Zoom
Schema: Dashboards
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: /metrics/meetings
Insert Zoom API URL: /metrics/meetings
Update Zoom API URL: /metrics/meetings
Delete Zoom API URL: /metrics/meetings
Field Selection Method: NotRequired
Base Path: meetings[*]
Select Zoom API Operation: get /metrics/meetings
Parameters of Table Function
The following parameters can be used to control the behaviour of the table function Metrics_MeetingsMeetings. 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 |
next_page_token |
string |
☐ |
|
Next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes. |
page_size |
int64 |
☐ |
30 |
The number of records returned within a single API call |
to |
datetime |
☑ |
|
End Date |
type |
string |
☐ |
live |
The meeting type (Values: past, pastOne, live) |
Table Function Columns
The columns of the table function Metrics_MeetingsMeetings are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
---|---|---|---|---|
duration |
string |
|
☐ |
Meeting duration |
string |
|
☐ |
User email |
|
end_time |
datetime |
|
☐ |
Meeting end time |
from |
datetime |
|
☐ |
Start date for this report |
has_3rd_party_audio |
boolean |
|
☐ |
|
has_pstn |
boolean |
|
☐ |
|
has_recording |
boolean |
|
☐ |
|
has_screen_share |
boolean |
|
☐ |
|
has_sip |
boolean |
|
☐ |
|
has_video |
boolean |
|
☐ |
|
has_voip |
boolean |
|
☐ |
|
host |
string |
|
☐ |
User display name |
id |
int64 |
|
☐ |
Meeting ID |
next_page_token |
string |
|
☐ |
Next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes. |
page_count |
int64 |
|
☐ |
The number of items returned on this page |
page_size |
int64 |
|
☐ |
The number of records returned within a single API call. |
participants |
int64 |
|
☐ |
Meeting participant count |
start_time |
datetime |
|
☐ |
Meeting start time |
to |
datetime |
|
☐ |
End date for this report |
topic |
string |
|
☐ |
Meeting topic |
total_records |
int64 |
|
☐ |
The number of all records available across pages |
user_type |
string |
|
☐ |
User type |
uuid |
guid |
|
☐ |
Meeting UUID |
16-06-2022 17:21 Version 22.1.46-BETA+3385