Class: DatadogAPIClient::V2::RumReplayHeatmapsAPI

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of RumReplayHeatmapsAPI.



22
23
24
 
# File 'lib/datadog_api_client/v2/api/rum_replay_heatmaps_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_heatmaps_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

#create_replay_heatmap_snapshot(body, opts = {}) ⇒ Object

Create replay heatmap snapshot.

See Also:



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

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

#create_replay_heatmap_snapshot_with_http_info(body, opts = {}) ⇒ Array<(Snapshot, Integer, Hash)>

Create replay heatmap snapshot.

Create a heatmap snapshot.

Parameters:

Returns:

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

    Snapshot data, response status code and response headers



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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/datadog_api_client/v2/api/rum_replay_heatmaps_api.rb', line 41

def create_replay_heatmap_snapshot_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RumReplayHeatmapsAPI.create_replay_heatmap_snapshot ...'
  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 RumReplayHeatmapsAPI.create_replay_heatmap_snapshot"
  end
  # resource path
  local_var_path = '/api/v2/replay/heatmap/snapshots'

  # 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] || 'Snapshot'

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

  new_options = opts.merge(
    :operation => :create_replay_heatmap_snapshot,
    :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: RumReplayHeatmapsAPI#create_replay_heatmap_snapshot\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_replay_heatmap_snapshot(snapshot_id, opts = {}) ⇒ Object

Delete replay heatmap snapshot.

See Also:



96
97
98
99
 
# File 'lib/datadog_api_client/v2/api/rum_replay_heatmaps_api.rb', line 96

def delete_replay_heatmap_snapshot(snapshot_id, opts = {})
  delete_replay_heatmap_snapshot_with_http_info(snapshot_id, opts)
  nil
end

#delete_replay_heatmap_snapshot_with_http_info(snapshot_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete replay heatmap snapshot.

Delete a heatmap snapshot.

Parameters:

  • snapshot_id (String) —

    Unique identifier of the heatmap snapshot.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/datadog_api_client/v2/api/rum_replay_heatmaps_api.rb', line 108

def delete_replay_heatmap_snapshot_with_http_info(snapshot_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RumReplayHeatmapsAPI.delete_replay_heatmap_snapshot ...'
  end
  # verify the required parameter 'snapshot_id' is set
  if @api_client.config.client_side_validation && snapshot_id.nil?
    fail ArgumentError, "Missing the required parameter 'snapshot_id' when calling RumReplayHeatmapsAPI.delete_replay_heatmap_snapshot"
  end
  # resource path
  local_var_path = '/api/v2/replay/heatmap/snapshots/{snapshot_id}'.sub('{snapshot_id}', CGI.escape(snapshot_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_replay_heatmap_snapshot,
    :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: RumReplayHeatmapsAPI#delete_replay_heatmap_snapshot\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_replay_heatmap_snapshots(filter_view_name, opts = {}) ⇒ Object

List replay heatmap snapshots.

See Also:



161
162
163
164
 
# File 'lib/datadog_api_client/v2/api/rum_replay_heatmaps_api.rb', line 161

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

#list_replay_heatmap_snapshots_with_http_info(filter_view_name, opts = {}) ⇒ Array<(SnapshotArray, Integer, Hash)>

List replay heatmap snapshots.

List heatmap snapshots.

Parameters:

  • filter_view_name (String) —

    View name to filter snapshots.

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

    the optional parameters

Options Hash (opts):

  • :filter_device_type (String) —

    Device type to filter snapshots.

  • :page_limit (Integer) —

    Maximum number of snapshots to return.

  • :filter_application_id (String) —

    Filter by application ID.

Returns:

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

    SnapshotArray data, response status code and response headers



176
177
178
179
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
 
# File 'lib/datadog_api_client/v2/api/rum_replay_heatmaps_api.rb', line 176

def list_replay_heatmap_snapshots_with_http_info(filter_view_name, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RumReplayHeatmapsAPI.list_replay_heatmap_snapshots ...'
  end
  # verify the required parameter 'filter_view_name' is set
  if @api_client.config.client_side_validation && filter_view_name.nil?
    fail ArgumentError, "Missing the required parameter 'filter_view_name' when calling RumReplayHeatmapsAPI.list_replay_heatmap_snapshots"
  end
  # resource path
  local_var_path = '/api/v2/replay/heatmap/snapshots'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter[view_name]'] = filter_view_name
  query_params[:'filter[device_type]'] = opts[:'filter_device_type'] if !opts[:'filter_device_type'].nil?
  query_params[:'page[limit]'] = opts[:'page_limit'] if !opts[:'page_limit'].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] || 'SnapshotArray'

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

  new_options = opts.merge(
    :operation => :list_replay_heatmap_snapshots,
    :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: RumReplayHeatmapsAPI#list_replay_heatmap_snapshots\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_replay_heatmap_snapshot(snapshot_id, body, opts = {}) ⇒ Object

Update replay heatmap snapshot.

See Also:



233
234
235
236
 
# File 'lib/datadog_api_client/v2/api/rum_replay_heatmaps_api.rb', line 233

def update_replay_heatmap_snapshot(snapshot_id, body, opts = {})
  data, _status_code, _headers = update_replay_heatmap_snapshot_with_http_info(snapshot_id, body, opts)
  data
end

#update_replay_heatmap_snapshot_with_http_info(snapshot_id, body, opts = {}) ⇒ Array<(Snapshot, Integer, Hash)>

Update replay heatmap snapshot.

Update a heatmap snapshot.

Parameters:

  • snapshot_id (String) —

    Unique identifier of the heatmap snapshot.

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

    the optional parameters

Returns:

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

    Snapshot data, response status code and response headers



246
247
248
249
250
251
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
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/datadog_api_client/v2/api/rum_replay_heatmaps_api.rb', line 246

def update_replay_heatmap_snapshot_with_http_info(snapshot_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RumReplayHeatmapsAPI.update_replay_heatmap_snapshot ...'
  end
  # verify the required parameter 'snapshot_id' is set
  if @api_client.config.client_side_validation && snapshot_id.nil?
    fail ArgumentError, "Missing the required parameter 'snapshot_id' when calling RumReplayHeatmapsAPI.update_replay_heatmap_snapshot"
  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 RumReplayHeatmapsAPI.update_replay_heatmap_snapshot"
  end
  # resource path
  local_var_path = '/api/v2/replay/heatmap/snapshots/{snapshot_id}'.sub('{snapshot_id}', CGI.escape(snapshot_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] || 'Snapshot'

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

  new_options = opts.merge(
    :operation => :update_replay_heatmap_snapshot,
    :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::Patch, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RumReplayHeatmapsAPI#update_replay_heatmap_snapshot\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end