Class: ZoomUs::Reports

Inherits:
Object
  • Object
show all
Defined in:
lib/zoom_us/reports.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ Reports

Returns a new instance of Reports.



19
20
21
 
# File 'lib/zoom_us/reports.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/zoom_us/reports.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_billing_invoices_reports(opts = {}) ⇒ InlineResponse200100

Get Billing Invoice Reports Get billing invoices reports for a specific billing period. Provide the ‘billing_id` of the billing period for which you would like to retrieve the invoices for. This ID can be retrieved from **Get Billing Reports** API. Prerequisites:
* Pro or a higher account with **Billing Report** option enabled. Scopes: `report:read:admin`, `report:master`

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :billing_id (String) —

    Unique Identifier of the Billing Report. Retrieve this ID from the response of **Get Billing Reports** API request.

Returns:

  • (InlineResponse200100) 


27
28
29
30
 
# File 'lib/zoom_us/reports.rb', line 27

def get_billing_invoices_reports(opts = {})
  data, _status_code, _headers = get_billing_invoices_reports_with_http_info(opts)
  data
end

#get_billing_invoices_reports_with_http_info(opts = {}) ⇒ Array<(InlineResponse200100, Fixnum, Hash)>

Get Billing Invoice Reports Get billing invoices reports for a specific billing period. Provide the &#x60;billing_id&#x60; of the billing period for which you would like to retrieve the invoices for. This ID can be retrieved from **Get Billing Reports** API. Prerequisites:&lt;br&gt; * Pro or a higher account with **Billing Report** option enabled. Scopes: &#x60;report:read:admin&#x60;, &#x60;report:master&#x60;

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :billing_id (String) —

    Unique Identifier of the Billing Report. Retrieve this ID from the response of **Get Billing Reports** API request.

Returns:

  • (Array<(InlineResponse200100, Fixnum, Hash)>) —

    InlineResponse200100 data, response status code and response headers



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/zoom_us/reports.rb', line 37

def get_billing_invoices_reports_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReportsApi.get_billing_invoices_reports ...'
  end
  # resource path
  local_var_path = '/report/billing/invoices'

  # query parameters
  query_params = {}
  query_params[:'billing_id'] = opts[:'billing_id'] if !opts[:'billing_id'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InlineResponse200100')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ReportsApi#get_billing_invoices_reports\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_billing_report(opts = {}) ⇒ InlineResponse20099

Get Billing Reports Get billing reports of a Zoom account. Prerequisites:
* Pro or a higher account with Billing Report option enabled. Scopes: ‘report:read:admin`, `report:master`

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (InlineResponse20099) 


77
78
79
80
 
# File 'lib/zoom_us/reports.rb', line 77

def get_billing_report(opts = {})
  data, _status_code, _headers = get_billing_report_with_http_info(opts)
  data
end

#get_billing_report_with_http_info(opts = {}) ⇒ Array<(InlineResponse20099, Fixnum, Hash)>

Get Billing Reports Get billing reports of a Zoom account. Prerequisites:&lt;br&gt; * Pro or a higher account with Billing Report option enabled. Scopes: &#x60;report:read:admin&#x60;, &#x60;report:master&#x60;

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(InlineResponse20099, Fixnum, Hash)>) —

    InlineResponse20099 data, response status code and response headers



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/zoom_us/reports.rb', line 86

def get_billing_report_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReportsApi.get_billing_report ...'
  end
  # resource path
  local_var_path = '/report/billing'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InlineResponse20099')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ReportsApi#get_billing_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#report_cloud_recording(from, to, opts = {}) ⇒ Object

Get Cloud Recording Usage Report Retrieve cloud recording usage report for a specified period. You can only get cloud recording reports that is one day ealier than the current date and for the most recent period of 6 months. The date gap between from and to dates should be smaller or equal to 30 days.
Prerequisites
* Pro or higher plan.
Scopes: ‘report:read:admin`

Parameters:

  • from —

    Start date in &#39;yyyy-mm-dd&#39; format. The date range defined by the &quot;from&quot; and &quot;to&quot; parameters should only be one month as the report includes only one month worth of data at once.

  • to —

    End date.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Object) 


127
128
129
130
 
# File 'lib/zoom_us/reports.rb', line 127

def report_cloud_recording(from, to, opts = {})
  data, _status_code, _headers = report_cloud_recording_with_http_info(from, to, opts)
  data
end

#report_cloud_recording_with_http_info(from, to, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

Get Cloud Recording Usage Report Retrieve cloud recording usage report for a specified period. You can only get cloud recording reports that is one day ealier than the current date and for the most recent period of 6 months. The date gap between from and to dates should be smaller or equal to 30 days. &lt;br&gt; Prerequisites&lt;br&gt; * Pro or higher plan.&lt;br&gt; Scopes: &#x60;report:read:admin&#x60;&lt;br&gt;

Parameters:

  • from —

    Start date in &#39;yyyy-mm-dd&#39; format. The date range defined by the &quot;from&quot; and &quot;to&quot; parameters should only be one month as the report includes only one month worth of data at once.

  • to —

    End date.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Fixnum, Hash)>) —

    Object data, response status code and response headers



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/zoom_us/reports.rb', line 138

def report_cloud_recording_with_http_info(from, to, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReportsApi.report_cloud_recording ...'
  end
  # verify the required parameter 'from' is set
  if @api_client.config.client_side_validation && from.nil?
    fail ArgumentError, "Missing the required parameter 'from' when calling ReportsApi.report_cloud_recording"
  end
  # verify the required parameter 'to' is set
  if @api_client.config.client_side_validation && to.nil?
    fail ArgumentError, "Missing the required parameter 'to' when calling ReportsApi.report_cloud_recording"
  end
  # resource path
  local_var_path = '/report/cloud_recording'

  # query parameters
  query_params = {}
  query_params[:'from'] = from
  query_params[:'to'] = to

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Object')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ReportsApi#report_cloud_recording\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#report_daily(opts = {}) ⇒ Object

Get Daily Usage Report Retrieve daily report to access the account-wide usage of Zoom services for each day in a given month. It lists the number of new users, meetings, participants, and meeting minutes.
Prerequisites
* Pro or higher plan.
Scopes: ‘report:read:admin`

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :year (Integer) —

    Year for this report

  • :month (Integer) —

    Month for this report

Returns:

  • (Object) 


189
190
191
192
 
# File 'lib/zoom_us/reports.rb', line 189

def report_daily(opts = {})
  data, _status_code, _headers = report_daily_with_http_info(opts)
  data
end

#report_daily_with_http_info(opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

Get Daily Usage Report Retrieve daily report to access the account-wide usage of Zoom services for each day in a given month. It lists the number of new users, meetings, participants, and meeting minutes.&lt;br&gt; Prerequisites&lt;br&gt; * Pro or higher plan.&lt;br&gt; Scopes: &#x60;report:read:admin&#x60;&lt;br&gt;

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :year (Integer) —

    Year for this report

  • :month (Integer) —

    Month for this report

Returns:

  • (Array<(Object, Fixnum, Hash)>) —

    Object data, response status code and response headers



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/zoom_us/reports.rb', line 200

def report_daily_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReportsApi.report_daily ...'
  end
  # resource path
  local_var_path = '/report/daily'

  # query parameters
  query_params = {}
  query_params[:'year'] = opts[:'year'] if !opts[:'year'].nil?
  query_params[:'month'] = opts[:'month'] if !opts[:'month'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Object')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ReportsApi#report_daily\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#report_meeting_details(meeting_id, opts = {}) ⇒ InlineResponse20036

Get Meeting Detail Reports Get a detailed report for a past meeting.
Scopes: ‘report:read:admin`
Prerequisites:
* Pro or a higher plan.

Parameters:

  • meeting_id —

    The meeting ID or meeting UUID. If given the meeting ID it will take the last meeting instance.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (InlineResponse20036) 


242
243
244
245
 
# File 'lib/zoom_us/reports.rb', line 242

def report_meeting_details(meeting_id, opts = {})
  data, _status_code, _headers = report_meeting_details_with_http_info(meeting_id, opts)
  data
end

#report_meeting_details_with_http_info(meeting_id, opts = {}) ⇒ Array<(InlineResponse20036, Fixnum, Hash)>

Get Meeting Detail Reports Get a detailed report for a past meeting. &lt;br&gt; Scopes: &#x60;report:read:admin&#x60;&lt;br&gt; Prerequisites:&lt;br&gt; * Pro or a higher plan.&lt;br&gt;

Parameters:

  • meeting_id —

    The meeting ID or meeting UUID. If given the meeting ID it will take the last meeting instance.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(InlineResponse20036, Fixnum, Hash)>) —

    InlineResponse20036 data, response status code and response headers



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/zoom_us/reports.rb', line 252

def report_meeting_details_with_http_info(meeting_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReportsApi.report_meeting_details ...'
  end
  # verify the required parameter 'meeting_id' is set
  if @api_client.config.client_side_validation && meeting_id.nil?
    fail ArgumentError, "Missing the required parameter 'meeting_id' when calling ReportsApi.report_meeting_details"
  end
  # resource path
  local_var_path = '/report/meetings/{meetingId}'.sub('{' + 'meetingId' + '}', meeting_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InlineResponse20036')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ReportsApi#report_meeting_details\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#report_meeting_participants(meeting_id, opts = {}) ⇒ InlineResponse20037

Get Meeting Participant Reports Get participant report for a past meeting.
Scopes: ‘report:read:admin`
Prerequisites:
* Pro or a higher plan.

Parameters:

  • meeting_id —

    The meeting ID or meeting UUID. If given the meeting ID it will take the last meeting instance.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of records returned within a single API call. (default to 30)

  • :next_page_token (String) —

    The 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.

Returns:

  • (InlineResponse20037) 


298
299
300
301
 
# File 'lib/zoom_us/reports.rb', line 298

def report_meeting_participants(meeting_id, opts = {})
  data, _status_code, _headers = report_meeting_participants_with_http_info(meeting_id, opts)
  data
end

#report_meeting_participants_with_http_info(meeting_id, opts = {}) ⇒ Array<(InlineResponse20037, Fixnum, Hash)>

Get Meeting Participant Reports Get participant report for a past meeting.&lt;br&gt;&lt;br&gt; Scopes: &#x60;report:read:admin&#x60;&lt;br&gt; Prerequisites:&lt;br&gt; * Pro or a higher plan.&lt;br&gt;

Parameters:

  • meeting_id —

    The meeting ID or meeting UUID. If given the meeting ID it will take the last meeting instance.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of records returned within a single API call.

  • :next_page_token (String) —

    The 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.

Returns:

  • (Array<(InlineResponse20037, Fixnum, Hash)>) —

    InlineResponse20037 data, response status code and response headers



310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/zoom_us/reports.rb', line 310

def report_meeting_participants_with_http_info(meeting_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReportsApi.report_meeting_participants ...'
  end
  # verify the required parameter 'meeting_id' is set
  if @api_client.config.client_side_validation && meeting_id.nil?
    fail ArgumentError, "Missing the required parameter 'meeting_id' when calling ReportsApi.report_meeting_participants"
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 300
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ReportsApi.report_meeting_participants, must be smaller than or equal to 300.'
  end

  # resource path
  local_var_path = '/report/meetings/{meetingId}/participants'.sub('{' + 'meetingId' + '}', meeting_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'next_page_token'] = opts[:'next_page_token'] if !opts[:'next_page_token'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InlineResponse20037')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ReportsApi#report_meeting_participants\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#report_meeting_polls(meeting_id, opts = {}) ⇒ InlineResponse20038

Get Meeting Poll Reports Retrieve a report of [poll](support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings) results for a past meeting.
Scopes: ‘report:read:admin`
Prerequisites:
* Pro or a higher plan.

Parameters:

  • meeting_id —

    The meeting ID or meeting UUID. If given the meeting ID it will take the last meeting instance.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (InlineResponse20038) 


360
361
362
363
 
# File 'lib/zoom_us/reports.rb', line 360

def report_meeting_polls(meeting_id, opts = {})
  data, _status_code, _headers = report_meeting_polls_with_http_info(meeting_id, opts)
  data
end

#report_meeting_polls_with_http_info(meeting_id, opts = {}) ⇒ Array<(InlineResponse20038, Fixnum, Hash)>

Get Meeting Poll Reports Retrieve a report of [poll](support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings) results for a past meeting. &lt;br&gt;&lt;br&gt; Scopes: &#x60;report:read:admin&#x60;&lt;br&gt; Prerequisites:&lt;br&gt; * Pro or a higher plan.&lt;br&gt;

Parameters:

  • meeting_id —

    The meeting ID or meeting UUID. If given the meeting ID it will take the last meeting instance.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(InlineResponse20038, Fixnum, Hash)>) —

    InlineResponse20038 data, response status code and response headers



370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
 
# File 'lib/zoom_us/reports.rb', line 370

def report_meeting_polls_with_http_info(meeting_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReportsApi.report_meeting_polls ...'
  end
  # verify the required parameter 'meeting_id' is set
  if @api_client.config.client_side_validation && meeting_id.nil?
    fail ArgumentError, "Missing the required parameter 'meeting_id' when calling ReportsApi.report_meeting_polls"
  end
  # resource path
  local_var_path = '/report/meetings/{meetingId}/polls'.sub('{' + 'meetingId' + '}', meeting_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InlineResponse20038')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ReportsApi#report_meeting_polls\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#report_meetings(user_id, from, to, opts = {}) ⇒ InlineResponse20035

Get Meeting Reports Retrieve [report](support.zoom.us/hc/en-us/articles/216378603-Meeting-Reporting) on a past meeting 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. Meetings will only be returned in the response if the meeting has two or more unique participants.
Scopes: ‘report:read:admin`

Prerequisites:
* Pro or higher plan.

Parameters:

  • user_id —

    The user ID or email address of the user. For user-level apps, pass &#x60;me&#x60; as the value for userId.

  • from —

    Start date in &#39;yyyy-mm-dd&#39; format. The date range defined by the &quot;from&quot; and &quot;to&quot; parameters should only be one month as the report includes only one month worth of data at once.

  • to —

    End date.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of records returned within a single API call. (default to 30)

  • :next_page_token (String) —

    The 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.

  • :type (String) —

    The meeting types: &lt;br&gt;&#x60;past&#x60; - Past meetings.&lt;br&gt;&#x60;pastOne&#x60; - Past one user meetings. (default to past)

Returns:

  • (InlineResponse20035) 


419
420
421
422
 
# File 'lib/zoom_us/reports.rb', line 419

def report_meetings(user_id, from, to, opts = {})
  data, _status_code, _headers = report_meetings_with_http_info(user_id, from, to, opts)
  data
end

#report_meetings_with_http_info(user_id, from, to, opts = {}) ⇒ Array<(InlineResponse20035, Fixnum, Hash)>

Get Meeting Reports Retrieve [report](support.zoom.us/hc/en-us/articles/216378603-Meeting-Reporting) on a past meeting 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. Meetings will only be returned in the response if the meeting has two or more unique participants. &lt;br&gt;&lt;br&gt; Scopes: &#x60;report:read:admin&#x60;&lt;br&gt; &lt;br&gt; Prerequisites:&lt;br&gt; * Pro or higher plan.

Parameters:

  • user_id —

    The user ID or email address of the user. For user-level apps, pass &#x60;me&#x60; as the value for userId.

  • from —

    Start date in &#39;yyyy-mm-dd&#39; format. The date range defined by the &quot;from&quot; and &quot;to&quot; parameters should only be one month as the report includes only one month worth of data at once.

  • to —

    End date.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of records returned within a single API call.

  • :next_page_token (String) —

    The 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.

  • :type (String) —

    The meeting types: &lt;br&gt;&#x60;past&#x60; - Past meetings.&lt;br&gt;&#x60;pastOne&#x60; - Past one user meetings.

Returns:

  • (Array<(InlineResponse20035, Fixnum, Hash)>) —

    InlineResponse20035 data, response status code and response headers



434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
 
# File 'lib/zoom_us/reports.rb', line 434

def report_meetings_with_http_info(user_id, from, to, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReportsApi.report_meetings ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling ReportsApi.report_meetings"
  end
  # verify the required parameter 'from' is set
  if @api_client.config.client_side_validation && from.nil?
    fail ArgumentError, "Missing the required parameter 'from' when calling ReportsApi.report_meetings"
  end
  # verify the required parameter 'to' is set
  if @api_client.config.client_side_validation && to.nil?
    fail ArgumentError, "Missing the required parameter 'to' when calling ReportsApi.report_meetings"
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 300
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ReportsApi.report_meetings, must be smaller than or equal to 300.'
  end

  if @api_client.config.client_side_validation && opts[:'type'] && !['past', 'pastOne'].include?(opts[:'type'])
    fail ArgumentError, 'invalid value for "type", must be one of past, pastOne'
  end
  # resource path
  local_var_path = '/report/users/{userId}/meetings'.sub('{' + 'userId' + '}', user_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'from'] = from
  query_params[:'to'] = to
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'next_page_token'] = opts[:'next_page_token'] if !opts[:'next_page_token'].nil?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InlineResponse20035')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ReportsApi#report_meetings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#report_operation_logs(from, to, opts = {}) ⇒ InlineResponse20044

Get Operation Logs Report The [Operations Logs](support.zoom.us/hc/en-us/articles/360032748331-Operation-Logs) report allows you to audit admin and user activity, such as adding a new user, changing account settings, and deleting recordings.
Use this API to retrieve operation logs report for a specified period of time.
Scopes: ‘report:read:admin`

Prerequisites:
* Pro or higher plan.

Parameters:

  • from —

    Start date in &#39;yyyy-mm-dd&#39; format. The date range defined by the &quot;from&quot; and &quot;to&quot; parameters should only be one month as the report includes only one month worth of data at once.

  • to —

    End date.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of records returned within a single API call. (default to 30)

  • :next_page_token (String) —

    The 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.

Returns:

  • (InlineResponse20044) 


501
502
503
504
 
# File 'lib/zoom_us/reports.rb', line 501

def report_operation_logs(from, to, opts = {})
  data, _status_code, _headers = report_operation_logs_with_http_info(from, to, opts)
  data
end

#report_operation_logs_with_http_info(from, to, opts = {}) ⇒ Array<(InlineResponse20044, Fixnum, Hash)>

Get Operation Logs Report The [Operations Logs](support.zoom.us/hc/en-us/articles/360032748331-Operation-Logs) report allows you to audit admin and user activity, such as adding a new user, changing account settings, and deleting recordings.&lt;br&gt; Use this API to retrieve operation logs report for a specified period of time.&lt;br&gt; Scopes: &#x60;report:read:admin&#x60;&lt;br&gt; &lt;br&gt; Prerequisites:&lt;br&gt; * Pro or higher plan.

Parameters:

  • from —

    Start date in &#39;yyyy-mm-dd&#39; format. The date range defined by the &quot;from&quot; and &quot;to&quot; parameters should only be one month as the report includes only one month worth of data at once.

  • to —

    End date.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of records returned within a single API call.

  • :next_page_token (String) —

    The 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.

Returns:

  • (Array<(InlineResponse20044, Fixnum, Hash)>) —

    InlineResponse20044 data, response status code and response headers



514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
 
# File 'lib/zoom_us/reports.rb', line 514

def report_operation_logs_with_http_info(from, to, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReportsApi.report_operation_logs ...'
  end
  # verify the required parameter 'from' is set
  if @api_client.config.client_side_validation && from.nil?
    fail ArgumentError, "Missing the required parameter 'from' when calling ReportsApi.report_operation_logs"
  end
  # verify the required parameter 'to' is set
  if @api_client.config.client_side_validation && to.nil?
    fail ArgumentError, "Missing the required parameter 'to' when calling ReportsApi.report_operation_logs"
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 300
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ReportsApi.report_operation_logs, must be smaller than or equal to 300.'
  end

  # resource path
  local_var_path = '/report/operationlogs'

  # query parameters
  query_params = {}
  query_params[:'from'] = from
  query_params[:'to'] = to
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'next_page_token'] = opts[:'next_page_token'] if !opts[:'next_page_token'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InlineResponse20044')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ReportsApi#report_operation_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#report_sign_in_sign_out_activities(opts = {}) ⇒ InlineResponse20068

Get Sign In / Sign Out Activity Report Retrieve a list of sign in / sign out activity logs [report](support.zoom.us/hc/en-us/articles/201363213-Getting-Started-with-Reports) of users under a Zoom account.
Prerequisites
* Pro or higher plan.
Scopes: ‘report:read:admin`

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :from (DateTime) —

    Start date for which you would like to view the activity logs report.

  • :to (DateTime) —

    End date up to which you would like to view the activity logs report.

  • :page_size (Integer) —

    The number of records to be returned within a single API call

  • :next_page_token (String) —

    Next page token is used to paginate through large result sets

Returns:

  • (InlineResponse20068) 


573
574
575
576
 
# File 'lib/zoom_us/reports.rb', line 573

def (opts = {})
  data, _status_code, _headers = (opts)
  data
end

#report_sign_in_sign_out_activities_with_http_info(opts = {}) ⇒ Array<(InlineResponse20068, Fixnum, Hash)>

Get Sign In / Sign Out Activity Report Retrieve a list of sign in / sign out activity logs [report](support.zoom.us/hc/en-us/articles/201363213-Getting-Started-with-Reports) of users under a Zoom account.&lt;br&gt; Prerequisites&lt;br&gt; * Pro or higher plan.&lt;br&gt; Scopes: &#x60;report:read:admin&#x60;&lt;br&gt;

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :from (DateTime) —

    Start date for which you would like to view the activity logs report.

  • :to (DateTime) —

    End date up to which you would like to view the activity logs report.

  • :page_size (Integer) —

    The number of records to be returned within a single API call

  • :next_page_token (String) —

    Next page token is used to paginate through large result sets

Returns:

  • (Array<(InlineResponse20068, Fixnum, Hash)>) —

    InlineResponse20068 data, response status code and response headers



586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
 
# File 'lib/zoom_us/reports.rb', line 586

def (opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReportsApi.report_sign_in_sign_out_activities ...'
  end
  # resource path
  local_var_path = '/report/activities'

  # query parameters
  query_params = {}
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'next_page_token'] = opts[:'next_page_token'] if !opts[:'next_page_token'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InlineResponse20068')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ReportsApi#report_sign_in_sign_out_activities\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#report_telephone(from, to, opts = {}) ⇒ InlineResponse20043

Get Telephone Reports The Telephone report allows you to view who dialed into meetings via phone (Audio Conferencing or SIP Connected Audio) and which number they dialed into and other details. Use this API to get telephone report for a specified period of time. Scopes: ‘report:read:admin`

Prerequisites:
* Pro or higher plan.

Parameters:

  • from —

    Start date in &#39;yyyy-mm-dd&#39; format. The date range defined by the &quot;from&quot; and &quot;to&quot; parameters should only be one month as the report includes only one month worth of data at once.

  • to —

    End date.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :type (String) —

    Audio types:&lt;br&gt;&#x60;1&#x60; - Toll-free Call-in &amp; Call-out. &#x60;3&#x60; - SIP Connected Audio (default to 1)

  • :page_size (Integer) —

    The number of records returned within a single API call. (default to 30)

  • :page_number (Integer) —

    The current page number of returned records. (default to 1)

Returns:

  • (InlineResponse20043) 


634
635
636
637
 
# File 'lib/zoom_us/reports.rb', line 634

def report_telephone(from, to, opts = {})
  data, _status_code, _headers = report_telephone_with_http_info(from, to, opts)
  data
end

#report_telephone_with_http_info(from, to, opts = {}) ⇒ Array<(InlineResponse20043, Fixnum, Hash)>

Get Telephone Reports The Telephone report allows you to view who dialed into meetings via phone (Audio Conferencing or SIP Connected Audio) and which number they dialed into and other details. Use this API to get telephone report for a specified period of time. Scopes: &#x60;report:read:admin&#x60;&lt;br&gt; &lt;br&gt;Prerequisites:&lt;br&gt; * Pro or higher plan.

Parameters:

  • from —

    Start date in &#39;yyyy-mm-dd&#39; format. The date range defined by the &quot;from&quot; and &quot;to&quot; parameters should only be one month as the report includes only one month worth of data at once.

  • to —

    End date.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :type (String) —

    Audio types:&lt;br&gt;&#x60;1&#x60; - Toll-free Call-in &amp; Call-out. &#x60;3&#x60; - SIP Connected Audio

  • :page_size (Integer) —

    The number of records returned within a single API call.

  • :page_number (Integer) —

    The current page number of returned records.

Returns:

  • (Array<(InlineResponse20043, Fixnum, Hash)>) —

    InlineResponse20043 data, response status code and response headers



648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
 
# File 'lib/zoom_us/reports.rb', line 648

def report_telephone_with_http_info(from, to, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReportsApi.report_telephone ...'
  end
  # verify the required parameter 'from' is set
  if @api_client.config.client_side_validation && from.nil?
    fail ArgumentError, "Missing the required parameter 'from' when calling ReportsApi.report_telephone"
  end
  # verify the required parameter 'to' is set
  if @api_client.config.client_side_validation && to.nil?
    fail ArgumentError, "Missing the required parameter 'to' when calling ReportsApi.report_telephone"
  end
  if @api_client.config.client_side_validation && opts[:'type'] && !['1', '3'].include?(opts[:'type'])
    fail ArgumentError, 'invalid value for "type", must be one of 1, 3'
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 300
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ReportsApi.report_telephone, must be smaller than or equal to 300.'
  end

  # resource path
  local_var_path = '/report/telephone'

  # query parameters
  query_params = {}
  query_params[:'from'] = from
  query_params[:'to'] = to
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'page_number'] = opts[:'page_number'] if !opts[:'page_number'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InlineResponse20043')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ReportsApi#report_telephone\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#report_users(from, to, opts = {}) ⇒ InlineResponse20034

Get Active/Inactive Host Reports 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`

Prerequisites:
* Pro or higher plan.

Parameters:

  • from —

    Start date in &#39;yyyy-mm-dd&#39; format. The date range defined by the &quot;from&quot; and &quot;to&quot; parameters should only be one month as the report includes only one month worth of data at once.

  • to —

    End date.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :type (String) —

    Active or inactive hosts.&lt;br&gt;&#x60;active&#x60; - Active hosts. &lt;br&gt;&#x60;inactive&#x60; - Inactive hosts.

  • :page_size (Integer) —

    The number of records returned within a single API call. (default to 30)

  • :page_number (Integer) —

    The current page number of returned records. (default to 1)

Returns:

  • (InlineResponse20034) 


712
713
714
715
 
# File 'lib/zoom_us/reports.rb', line 712

def report_users(from, to, opts = {})
  data, _status_code, _headers = report_users_with_http_info(from, to, opts)
  data
end

#report_users_with_http_info(from, to, opts = {}) ⇒ Array<(InlineResponse20034, Fixnum, Hash)>

Get Active/Inactive Host Reports A user is considered to be an active host during the month specified in the &quot;from&quot; and &quot;to&quot; range, if the user has hosted at least one meeting during this period. If the user didn&#39;t host any meetings during this period, the user is considered to be inactive.&lt;br&gt;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.&lt;br&gt;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. &lt;br&gt;You can specify the type of report and date range using the query parameters.&lt;br&gt; Scopes: &#x60;report:read:admin&#x60;&lt;br&gt; &lt;br&gt; Prerequisites:&lt;br&gt; * Pro or higher plan.

Parameters:

  • from —

    Start date in &#39;yyyy-mm-dd&#39; format. The date range defined by the &quot;from&quot; and &quot;to&quot; parameters should only be one month as the report includes only one month worth of data at once.

  • to —

    End date.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :type (String) —

    Active or inactive hosts.&lt;br&gt;&#x60;active&#x60; - Active hosts. &lt;br&gt;&#x60;inactive&#x60; - Inactive hosts.

  • :page_size (Integer) —

    The number of records returned within a single API call.

  • :page_number (Integer) —

    The current page number of returned records.

Returns:

  • (Array<(InlineResponse20034, Fixnum, Hash)>) —

    InlineResponse20034 data, response status code and response headers



726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
 
# File 'lib/zoom_us/reports.rb', line 726

def report_users_with_http_info(from, to, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReportsApi.report_users ...'
  end
  # verify the required parameter 'from' is set
  if @api_client.config.client_side_validation && from.nil?
    fail ArgumentError, "Missing the required parameter 'from' when calling ReportsApi.report_users"
  end
  # verify the required parameter 'to' is set
  if @api_client.config.client_side_validation && to.nil?
    fail ArgumentError, "Missing the required parameter 'to' when calling ReportsApi.report_users"
  end
  if @api_client.config.client_side_validation && opts[:'type'] && !['active', 'inactive'].include?(opts[:'type'])
    fail ArgumentError, 'invalid value for "type", must be one of active, inactive'
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 300
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ReportsApi.report_users, must be smaller than or equal to 300.'
  end

  # resource path
  local_var_path = '/report/users'

  # query parameters
  query_params = {}
  query_params[:'from'] = from
  query_params[:'to'] = to
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'page_number'] = opts[:'page_number'] if !opts[:'page_number'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InlineResponse20034')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ReportsApi#report_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#report_webinar_details(webinar_id, opts = {}) ⇒ InlineResponse20039

Get Webinar Detail Reports Retrieve a [report](support.zoom.us/hc/en-us/articles/201393719-Webinar-Reporting) containing past webinar details.
Scopes: ‘report:read:admin`

Prerequisites:
* Pro or higher plan with Webinar add-on.

Parameters:

  • webinar_id —

    The webinar ID or webinar UUID. If given the webinar ID it will take the last webinar instance.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (InlineResponse20039) 


786
787
788
789
 
# File 'lib/zoom_us/reports.rb', line 786

def report_webinar_details(webinar_id, opts = {})
  data, _status_code, _headers = report_webinar_details_with_http_info(webinar_id, opts)
  data
end

#report_webinar_details_with_http_info(webinar_id, opts = {}) ⇒ Array<(InlineResponse20039, Fixnum, Hash)>

Get Webinar Detail Reports Retrieve a [report](support.zoom.us/hc/en-us/articles/201393719-Webinar-Reporting) containing past webinar details. &lt;br&gt;&lt;br&gt; Scopes: &#x60;report:read:admin&#x60;&lt;br&gt; &lt;br&gt; Prerequisites:&lt;br&gt; * Pro or higher plan with Webinar add-on.

Parameters:

  • webinar_id —

    The webinar ID or webinar UUID. If given the webinar ID it will take the last webinar instance.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(InlineResponse20039, Fixnum, Hash)>) —

    InlineResponse20039 data, response status code and response headers



796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
 
# File 'lib/zoom_us/reports.rb', line 796

def report_webinar_details_with_http_info(webinar_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReportsApi.report_webinar_details ...'
  end
  # verify the required parameter 'webinar_id' is set
  if @api_client.config.client_side_validation && webinar_id.nil?
    fail ArgumentError, "Missing the required parameter 'webinar_id' when calling ReportsApi.report_webinar_details"
  end
  # resource path
  local_var_path = '/report/webinars/{webinarId}'.sub('{' + 'webinarId' + '}', webinar_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InlineResponse20039')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ReportsApi#report_webinar_details\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#report_webinar_participants(webinar_id, opts = {}) ⇒ InlineResponse20040

Get Webinar Participant Reports Get detailed report on each attendee of a webinar.
Scopes: ‘report:read:admin`

Prerequisites:
* Pro or a higher plan with Webinar add-on enabled.

Parameters:

  • webinar_id —

    The webinar ID or webinar UUID. If given the webinar ID it will take the last webinar instance.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of records returned within a single API call. (default to 30)

  • :next_page_token (String) —

    The 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.

Returns:

  • (InlineResponse20040) 


842
843
844
845
 
# File 'lib/zoom_us/reports.rb', line 842

def report_webinar_participants(webinar_id, opts = {})
  data, _status_code, _headers = report_webinar_participants_with_http_info(webinar_id, opts)
  data
end

#report_webinar_participants_with_http_info(webinar_id, opts = {}) ⇒ Array<(InlineResponse20040, Fixnum, Hash)>

Get Webinar Participant Reports Get detailed report on each attendee of a webinar.&lt;br&gt;&lt;br&gt; Scopes: &#x60;report:read:admin&#x60;&lt;br&gt; &lt;br&gt; Prerequisites:&lt;br&gt; * Pro or a higher plan with Webinar add-on enabled.

Parameters:

  • webinar_id —

    The webinar ID or webinar UUID. If given the webinar ID it will take the last webinar instance.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of records returned within a single API call.

  • :next_page_token (String) —

    The 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.

Returns:

  • (Array<(InlineResponse20040, Fixnum, Hash)>) —

    InlineResponse20040 data, response status code and response headers



854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
 
# File 'lib/zoom_us/reports.rb', line 854

def report_webinar_participants_with_http_info(webinar_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReportsApi.report_webinar_participants ...'
  end
  # verify the required parameter 'webinar_id' is set
  if @api_client.config.client_side_validation && webinar_id.nil?
    fail ArgumentError, "Missing the required parameter 'webinar_id' when calling ReportsApi.report_webinar_participants"
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 300
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ReportsApi.report_webinar_participants, must be smaller than or equal to 300.'
  end

  # resource path
  local_var_path = '/report/webinars/{webinarId}/participants'.sub('{' + 'webinarId' + '}', webinar_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'next_page_token'] = opts[:'next_page_token'] if !opts[:'next_page_token'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InlineResponse20040')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ReportsApi#report_webinar_participants\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#report_webinar_polls(webinar_id, opts = {}) ⇒ InlineResponse20041

Get Webinar Poll Reports Retrieve a report on past [webinar polls](support.zoom.us/hc/en-us/articles/203749865-Polling-for-Webinars).
Scopes: ‘report:read:admin`

Prerequisites:
* Pro or a higher plan with Webinar add-on enabled.

Parameters:

  • webinar_id —

    The webinar ID or webinar UUID. If given the webinar ID it will take the last webinar instance.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (InlineResponse20041) 


904
905
906
907
 
# File 'lib/zoom_us/reports.rb', line 904

def report_webinar_polls(webinar_id, opts = {})
  data, _status_code, _headers = report_webinar_polls_with_http_info(webinar_id, opts)
  data
end

#report_webinar_polls_with_http_info(webinar_id, opts = {}) ⇒ Array<(InlineResponse20041, Fixnum, Hash)>

Get Webinar Poll Reports Retrieve a report on past [webinar polls](support.zoom.us/hc/en-us/articles/203749865-Polling-for-Webinars).&lt;br&gt;&lt;br&gt; Scopes: &#x60;report:read:admin&#x60;&lt;br&gt; &lt;br&gt; Prerequisites:&lt;br&gt; * Pro or a higher plan with Webinar add-on enabled.

Parameters:

  • webinar_id —

    The webinar ID or webinar UUID. If given the webinar ID it will take the last webinar instance.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(InlineResponse20041, Fixnum, Hash)>) —

    InlineResponse20041 data, response status code and response headers



914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
 
# File 'lib/zoom_us/reports.rb', line 914

def report_webinar_polls_with_http_info(webinar_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReportsApi.report_webinar_polls ...'
  end
  # verify the required parameter 'webinar_id' is set
  if @api_client.config.client_side_validation && webinar_id.nil?
    fail ArgumentError, "Missing the required parameter 'webinar_id' when calling ReportsApi.report_webinar_polls"
  end
  # resource path
  local_var_path = '/report/webinars/{webinarId}/polls'.sub('{' + 'webinarId' + '}', webinar_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InlineResponse20041')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ReportsApi#report_webinar_polls\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#report_webinar_qa(webinar_id, opts = {}) ⇒ InlineResponse20042

Get Webinar Q&A Report The Question & Answer (Q&A) feature for webinars allows attendees to ask questions during the webinar and for the panelists, co-hosts and host to answer their questions. Use this API to retrieve a report on question and answers from past webinars.
Scopes: ‘report:read:admin`

Prerequisites:
* Pro or a higher plan with Webinar add-on enabled.

Parameters:

  • webinar_id —

    The webinar ID or webinar UUID. If given the webinar ID it will take the last webinar instance.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (InlineResponse20042) 


958
959
960
961
 
# File 'lib/zoom_us/reports.rb', line 958

def report_webinar_qa(webinar_id, opts = {})
  data, _status_code, _headers = report_webinar_qa_with_http_info(webinar_id, opts)
  data
end

#report_webinar_qa_with_http_info(webinar_id, opts = {}) ⇒ Array<(InlineResponse20042, Fixnum, Hash)>

Get Webinar Q&amp;A Report The Question &amp; Answer (Q&amp;A) feature for webinars allows attendees to ask questions during the webinar and for the panelists, co-hosts and host to answer their questions. Use this API to retrieve a report on question and answers from past webinars. &lt;br&gt;&lt;br&gt; Scopes: &#x60;report:read:admin&#x60;&lt;br&gt; &lt;br&gt; Prerequisites:&lt;br&gt; * Pro or a higher plan with Webinar add-on enabled.

Parameters:

  • webinar_id —

    The webinar ID or webinar UUID. If given the webinar ID it will take the last webinar instance.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(InlineResponse20042, Fixnum, Hash)>) —

    InlineResponse20042 data, response status code and response headers



968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
 
# File 'lib/zoom_us/reports.rb', line 968

def report_webinar_qa_with_http_info(webinar_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReportsApi.report_webinar_qa ...'
  end
  # verify the required parameter 'webinar_id' is set
  if @api_client.config.client_side_validation && webinar_id.nil?
    fail ArgumentError, "Missing the required parameter 'webinar_id' when calling ReportsApi.report_webinar_qa"
  end
  # resource path
  local_var_path = '/report/webinars/{webinarId}/qa'.sub('{' + 'webinarId' + '}', webinar_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InlineResponse20042')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ReportsApi#report_webinar_qa\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end