Class: DatadogAPIClient::V2::RumReplayViewershipAPI

Inherits:
Object
  • Object
show all
Defined in:
lib/datadog_api_client/v2/api/rum_replay_viewership_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = DatadogAPIClient::APIClient.default) ⇒ RumReplayViewershipAPI

Returns a new instance of RumReplayViewershipAPI.



22
23
24
 
# File 'lib/datadog_api_client/v2/api/rum_replay_viewership_api.rb', line 22

def initialize(api_client = DatadogAPIClient::APIClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



20
21
22
 
# File 'lib/datadog_api_client/v2/api/rum_replay_viewership_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

#create_rum_replay_session_watch(session_id, body, opts = {}) ⇒ Object

Create rum replay session watch.

See Also:



29
30
31
32
 
# File 'lib/datadog_api_client/v2/api/rum_replay_viewership_api.rb', line 29

def create_rum_replay_session_watch(session_id, body, opts = {})
  data, _status_code, _headers = create_rum_replay_session_watch_with_http_info(session_id, body, opts)
  data
end

#create_rum_replay_session_watch_with_http_info(session_id, body, opts = {}) ⇒ Array<(Watch, Integer, Hash)>

Create rum replay session watch.

Record a session watch.

Parameters:

  • session_id (String) —

    Unique identifier of the session.

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

    the optional parameters

Returns:

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

    Watch data, response status code and response headers



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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/datadog_api_client/v2/api/rum_replay_viewership_api.rb', line 42

def create_rum_replay_session_watch_with_http_info(session_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RumReplayViewershipAPI.create_rum_replay_session_watch ...'
  end
  # verify the required parameter 'session_id' is set
  if @api_client.config.client_side_validation && session_id.nil?
    fail ArgumentError, "Missing the required parameter 'session_id' when calling RumReplayViewershipAPI.create_rum_replay_session_watch"
  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 RumReplayViewershipAPI.create_rum_replay_session_watch"
  end
  # resource path
  local_var_path = '/api/v2/rum/replay/sessions/{session_id}/watches'.sub('{session_id}', CGI.escape(session_id.to_s).gsub('%2F', '/'))

  # 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[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'Watch'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :create_rum_replay_session_watch,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RumReplayViewershipAPI#create_rum_replay_session_watch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_rum_replay_session_watch(session_id, opts = {}) ⇒ Object

Delete rum replay session watch.

See Also:



101
102
103
104
 
# File 'lib/datadog_api_client/v2/api/rum_replay_viewership_api.rb', line 101

def delete_rum_replay_session_watch(session_id, opts = {})
  delete_rum_replay_session_watch_with_http_info(session_id, opts)
  nil
end

#delete_rum_replay_session_watch_with_http_info(session_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete rum replay session watch.

Delete session watch history.

Parameters:

  • session_id (String) —

    Unique identifier of the session.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/datadog_api_client/v2/api/rum_replay_viewership_api.rb', line 113

def delete_rum_replay_session_watch_with_http_info(session_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RumReplayViewershipAPI.delete_rum_replay_session_watch ...'
  end
  # verify the required parameter 'session_id' is set
  if @api_client.config.client_side_validation && session_id.nil?
    fail ArgumentError, "Missing the required parameter 'session_id' when calling RumReplayViewershipAPI.delete_rum_replay_session_watch"
  end
  # resource path
  local_var_path = '/api/v2/rum/replay/sessions/{session_id}/watches'.sub('{session_id}', CGI.escape(session_id.to_s).gsub('%2F', '/'))

  # 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(['*/*'])

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

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :delete_rum_replay_session_watch,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Delete, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RumReplayViewershipAPI#delete_rum_replay_session_watch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_rum_replay_session_watchers(session_id, opts = {}) ⇒ Object

List rum replay session watchers.

See Also:



166
167
168
169
 
# File 'lib/datadog_api_client/v2/api/rum_replay_viewership_api.rb', line 166

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

#list_rum_replay_session_watchers_with_http_info(session_id, opts = {}) ⇒ Array<(WatcherArray, Integer, Hash)>

List rum replay session watchers.

List session watchers.

Parameters:

  • session_id (String) —

    Unique identifier of the session.

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Number of items per page.

  • :page_number (Integer) —

    Page number for pagination (0-indexed).

Returns:

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

    WatcherArray data, response status code and response headers



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
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
 
# File 'lib/datadog_api_client/v2/api/rum_replay_viewership_api.rb', line 180

def list_rum_replay_session_watchers_with_http_info(session_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RumReplayViewershipAPI.list_rum_replay_session_watchers ...'
  end
  # verify the required parameter 'session_id' is set
  if @api_client.config.client_side_validation && session_id.nil?
    fail ArgumentError, "Missing the required parameter 'session_id' when calling RumReplayViewershipAPI.list_rum_replay_session_watchers"
  end
  # resource path
  local_var_path = '/api/v2/rum/replay/sessions/{session_id}/watchers'.sub('{session_id}', CGI.escape(session_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}
  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 = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

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

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'WatcherArray'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :list_rum_replay_session_watchers,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RumReplayViewershipAPI#list_rum_replay_session_watchers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_rum_replay_viewership_history_sessions(opts = {}) ⇒ Object

List rum replay viewership history sessions.

See Also:



235
236
237
238
 
# File 'lib/datadog_api_client/v2/api/rum_replay_viewership_api.rb', line 235

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

#list_rum_replay_viewership_history_sessions_with_http_info(opts = {}) ⇒ Array<(ViewershipHistorySessionArray, Integer, Hash)>

List rum replay viewership history sessions.

List watched sessions.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter_watched_at_start (Integer) —

    Start timestamp in milliseconds for watched_at filter.

  • :page_number (Integer) —

    Page number for pagination (0-indexed).

  • :filter_created_by (String) —

    Filter by user UUID. Defaults to current user if not specified.

  • :filter_watched_at_end (Integer) —

    End timestamp in milliseconds for watched_at filter.

  • :filter_session_ids (String) —

    Comma-separated list of session IDs to filter by.

  • :page_size (Integer) —

    Number of items per page.

  • :filter_application_id (String) —

    Filter by application ID.

Returns:



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
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/datadog_api_client/v2/api/rum_replay_viewership_api.rb', line 253

def list_rum_replay_viewership_history_sessions_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RumReplayViewershipAPI.list_rum_replay_viewership_history_sessions ...'
  end
  # resource path
  local_var_path = '/api/v2/rum/replay/viewership-history/sessions'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter[watched_at][start]'] = opts[:'filter_watched_at_start'] if !opts[:'filter_watched_at_start'].nil?
  query_params[:'page[number]'] = opts[:'page_number'] if !opts[:'page_number'].nil?
  query_params[:'filter[created_by]'] = opts[:'filter_created_by'] if !opts[:'filter_created_by'].nil?
  query_params[:'filter[watched_at][end]'] = opts[:'filter_watched_at_end'] if !opts[:'filter_watched_at_end'].nil?
  query_params[:'filter[session_ids]'] = opts[:'filter_session_ids'] if !opts[:'filter_session_ids'].nil?
  query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'filter[application_id]'] = opts[:'filter_application_id'] if !opts[:'filter_application_id'].nil?

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

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

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ViewershipHistorySessionArray'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :list_rum_replay_viewership_history_sessions,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RumReplayViewershipAPI#list_rum_replay_viewership_history_sessions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end