Class: GongAPI::StatsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/gong_api/api/stats_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ StatsApi

Returns a new instance of StatsApi.



16
17
18
 
# File 'lib/gong_api/api/stats_api.rb', line 16

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



14
15
16
 
# File 'lib/gong_api/api/stats_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#list_answered_scorecards_using_post(body, opts = {}) ⇒ AnsweredScorecards

Retrieve answered scorecards for applicable reviewed users or scorecards for a date range (/v2/stats/activity/scorecards) Retrieve all the answers for the scorecards that were reviewed during a specified date range, for calls that took place during a specified date range, for specific scorecards or for specific reviewed users. When accessed through a Bearer token authorization method, this endpoint requires the scope ‘api:stats:scorecards’.

Parameters:

  • body —

    answeredScorecardsRequest

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

    the optional parameters

Returns:



24
25
26
27
 
# File 'lib/gong_api/api/stats_api.rb', line 24

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

#list_answered_scorecards_using_post_with_http_info(body, opts = {}) ⇒ Array<(AnsweredScorecards, Integer, Hash)>

Retrieve answered scorecards for applicable reviewed users or scorecards for a date range (/v2/stats/activity/scorecards) Retrieve all the answers for the scorecards that were reviewed during a specified date range, for calls that took place during a specified date range, for specific scorecards or for specific reviewed users. When accessed through a Bearer token authorization method, this endpoint requires the scope &#x27;api:stats:scorecards&#x27;.

Parameters:

  • body —

    answeredScorecardsRequest

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

    the optional parameters

Returns:

  • (Array<(AnsweredScorecards, Integer, Hash)>) —

    AnsweredScorecards data, response status code and response headers



34
35
36
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
73
74
75
76
 
# File 'lib/gong_api/api/stats_api.rb', line 34

def list_answered_scorecards_using_post_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatsApi.list_answered_scorecards_using_post ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling StatsApi.list_answered_scorecards_using_post"
  end
  # resource path
  local_var_path = '/v2/stats/activity/scorecards'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  return_type = opts[:return_type] || 'AnsweredScorecards' 

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StatsApi#list_answered_scorecards_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_interaction_stats_using_post(body, opts = {}) ⇒ CompanyUsersIntercationStatsResponse

Retrieve interaction stats for applicable users by date (/v2/stats/interaction) Returns interaction stats for users based on calls that have Whisper turned on. When accessed through a Bearer token authorization method, this endpoint requires the scope ‘api:stats:interaction’.

Parameters:

  • body —

    statsRequest

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

    the optional parameters

Returns:



82
83
84
85
 
# File 'lib/gong_api/api/stats_api.rb', line 82

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

#list_interaction_stats_using_post_with_http_info(body, opts = {}) ⇒ Array<(CompanyUsersIntercationStatsResponse, Integer, Hash)>

Retrieve interaction stats for applicable users by date (/v2/stats/interaction) Returns interaction stats for users based on calls that have Whisper turned on. When accessed through a Bearer token authorization method, this endpoint requires the scope &#x27;api:stats:interaction&#x27;.

Parameters:

  • body —

    statsRequest

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

    the optional parameters

Returns:



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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/gong_api/api/stats_api.rb', line 92

def list_interaction_stats_using_post_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatsApi.list_interaction_stats_using_post ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling StatsApi.list_interaction_stats_using_post"
  end
  # resource path
  local_var_path = '/v2/stats/interaction'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  return_type = opts[:return_type] || 'CompanyUsersIntercationStatsResponse' 

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StatsApi#list_interaction_stats_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_multiple_users_aggregate_activity_using_post(body, opts = {}) ⇒ CompanyUsersAggregateActivityResponse

Retrieve aggregated activity for defined users by date (/v2/stats/activity/aggregate) Lists the activity of multiple users within the Gong system during a defined period. Given the period, this endpoint returns multiple records, one for each user, with an applicable activity during the period. Each record includes statistics about the user’s activity. When accessed through a Bearer token authorization method, this endpoint requires the scope ‘api:stats:user-actions’.

Parameters:

  • body —

    multipleUsersRequest

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

    the optional parameters

Returns:



140
141
142
143
 
# File 'lib/gong_api/api/stats_api.rb', line 140

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

#list_multiple_users_aggregate_activity_using_post_with_http_info(body, opts = {}) ⇒ Array<(CompanyUsersAggregateActivityResponse, Integer, Hash)>

Retrieve aggregated activity for defined users by date (/v2/stats/activity/aggregate) Lists the activity of multiple users within the Gong system during a defined period. Given the period, this endpoint returns multiple records, one for each user, with an applicable activity during the period. Each record includes statistics about the user&#x27;s activity. When accessed through a Bearer token authorization method, this endpoint requires the scope &#x27;api:stats:user-actions&#x27;.

Parameters:

  • body —

    multipleUsersRequest

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

    the optional parameters

Returns:



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
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/gong_api/api/stats_api.rb', line 150

def list_multiple_users_aggregate_activity_using_post_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatsApi.list_multiple_users_aggregate_activity_using_post ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling StatsApi.list_multiple_users_aggregate_activity_using_post"
  end
  # resource path
  local_var_path = '/v2/stats/activity/aggregate'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  return_type = opts[:return_type] || 'CompanyUsersAggregateActivityResponse' 

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StatsApi#list_multiple_users_aggregate_activity_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_multiple_users_aggregate_by_period_using_post(body, opts = {}) ⇒ UsersAggregateByPeriodActivity

Retrieve aggregated activity for defined users by a date range with grouping in time periods (/v2/stats/activity/aggregate-by-period) Lists the aggregated activity of multiple users within the Gong system for each time period within the defined date range. This endpoint returns multiple records, one for each user. For each user there are items for every time period in the date range, including statistics about the user’s activity. Records are returned only for users with activity in the range. When accessed through a Bearer token authorization method, this endpoint requires the scope ‘api:stats:user-actions’.

Parameters:

  • body —

    multipleUsersRequest

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

    the optional parameters

Returns:



198
199
200
201
 
# File 'lib/gong_api/api/stats_api.rb', line 198

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

#list_multiple_users_aggregate_by_period_using_post_with_http_info(body, opts = {}) ⇒ Array<(UsersAggregateByPeriodActivity, Integer, Hash)>

Retrieve aggregated activity for defined users by a date range with grouping in time periods (/v2/stats/activity/aggregate-by-period) Lists the aggregated activity of multiple users within the Gong system for each time period within the defined date range. This endpoint returns multiple records, one for each user. For each user there are items for every time period in the date range, including statistics about the user&#x27;s activity. Records are returned only for users with activity in the range. When accessed through a Bearer token authorization method, this endpoint requires the scope &#x27;api:stats:user-actions&#x27;.

Parameters:

  • body —

    multipleUsersRequest

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

    the optional parameters

Returns:



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
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/gong_api/api/stats_api.rb', line 208

def list_multiple_users_aggregate_by_period_using_post_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatsApi.list_multiple_users_aggregate_by_period_using_post ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling StatsApi.list_multiple_users_aggregate_by_period_using_post"
  end
  # resource path
  local_var_path = '/v2/stats/activity/aggregate-by-period'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  return_type = opts[:return_type] || 'UsersAggregateByPeriodActivity' 

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StatsApi#list_multiple_users_aggregate_by_period_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_multiple_users_day_by_day_activity_using_post(body, opts = {}) ⇒ UsersDayByDayActivity

Retrieve daily activity for applicable users for a date range (/v2/stats/activity/day-by-day) Retrieve the daily activity of multiple users within the Gong system for a range of dates. This endpoint returns records including statistics about each user’s activity, on the daily level. Records are returned only for users with activity in the range. When accessed through a Bearer token authorization method, this endpoint requires the scope ‘api:stats:user-actions:detailed’.

Parameters:

  • body —

    multipleUsersRequest

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

    the optional parameters

Returns:



256
257
258
259
 
# File 'lib/gong_api/api/stats_api.rb', line 256

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

#list_multiple_users_day_by_day_activity_using_post_with_http_info(body, opts = {}) ⇒ Array<(UsersDayByDayActivity, Integer, Hash)>

Retrieve daily activity for applicable users for a date range (/v2/stats/activity/day-by-day) Retrieve the daily activity of multiple users within the Gong system for a range of dates. This endpoint returns records including statistics about each user&#x27;s activity, on the daily level. Records are returned only for users with activity in the range. When accessed through a Bearer token authorization method, this endpoint requires the scope &#x27;api:stats:user-actions:detailed&#x27;.

Parameters:

  • body —

    multipleUsersRequest

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

    the optional parameters

Returns:

  • (Array<(UsersDayByDayActivity, Integer, Hash)>) —

    UsersDayByDayActivity data, response status code and response headers



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
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/gong_api/api/stats_api.rb', line 266

def list_multiple_users_day_by_day_activity_using_post_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatsApi.list_multiple_users_day_by_day_activity_using_post ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling StatsApi.list_multiple_users_day_by_day_activity_using_post"
  end
  # resource path
  local_var_path = '/v2/stats/activity/day-by-day'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  return_type = opts[:return_type] || 'UsersDayByDayActivity' 

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StatsApi#list_multiple_users_day_by_day_activity_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end