Class: LaunchDarklyApi::InsightsChartsBetaApi

Inherits:
Object
  • Object
show all
Defined in:
lib/launchdarkly_api/api/insights_charts_beta_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ InsightsChartsBetaApi

Returns a new instance of InsightsChartsBetaApi.



19
20
21
 
# File 'lib/launchdarkly_api/api/insights_charts_beta_api.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/launchdarkly_api/api/insights_charts_beta_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_deployment_frequency_chart(opts = {}) ⇒ InsightsChart

Get deployment frequency chart data Get deployment frequency chart data. Engineering insights displays deployment frequency data in the [deployment frequency metric view](launchdarkly.com/docs/home/observability/deployments). ### Expanding the chart response LaunchDarkly supports expanding the chart response to include additional fields. To expand the response, append the ‘expand` query parameter and include the following: * `metrics` includes details on the metrics related to deployment frequency For example, use `?expand=metrics` to include the `metrics` field in the response. By default, this field is not included in the response.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :project_key (String) —

    The project key

  • :environment_key (String) —

    The environment key

  • :application_key (String) —

    Comma separated list of application keys

  • :from (Time) —

    Unix timestamp in milliseconds. Default value is 7 days ago.

  • :to (Time) —

    Unix timestamp in milliseconds. Default value is now.

  • :bucket_type (String) —

    Specify type of bucket. Options: `rolling`, `hour`, `day`. Default: `rolling`.

  • :bucket_ms (Integer) —

    Duration of intervals for x-axis in milliseconds. Default value is one day (`86400000` milliseconds).

  • :group_by (String) —

    Options: `application`, `kind`

  • :expand (String) —

    Options: `metrics`

Returns:



35
36
37
38
 
# File 'lib/launchdarkly_api/api/insights_charts_beta_api.rb', line 35

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

#get_deployment_frequency_chart_with_http_info(opts = {}) ⇒ Array<(InsightsChart, Integer, Hash)>

Get deployment frequency chart data Get deployment frequency chart data. Engineering insights displays deployment frequency data in the [deployment frequency metric view](launchdarkly.com/docs/home/observability/deployments). ### Expanding the chart response LaunchDarkly supports expanding the chart response to include additional fields. To expand the response, append the &#x60;expand&#x60; query parameter and include the following: * &#x60;metrics&#x60; includes details on the metrics related to deployment frequency For example, use &#x60;?expand&#x3D;metrics&#x60; to include the &#x60;metrics&#x60; field in the response. By default, this field is not included in the response.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :project_key (String) —

    The project key

  • :environment_key (String) —

    The environment key

  • :application_key (String) —

    Comma separated list of application keys

  • :from (Time) —

    Unix timestamp in milliseconds. Default value is 7 days ago.

  • :to (Time) —

    Unix timestamp in milliseconds. Default value is now.

  • :bucket_type (String) —

    Specify type of bucket. Options: &#x60;rolling&#x60;, &#x60;hour&#x60;, &#x60;day&#x60;. Default: &#x60;rolling&#x60;.

  • :bucket_ms (Integer) —

    Duration of intervals for x-axis in milliseconds. Default value is one day (&#x60;86400000&#x60; milliseconds).

  • :group_by (String) —

    Options: &#x60;application&#x60;, &#x60;kind&#x60;

  • :expand (String) —

    Options: &#x60;metrics&#x60;

Returns:

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

    InsightsChart data, response status code and response headers



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
97
98
99
100
101
102
103
104
 
# File 'lib/launchdarkly_api/api/insights_charts_beta_api.rb', line 53

def get_deployment_frequency_chart_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InsightsChartsBetaApi.get_deployment_frequency_chart ...'
  end
  # resource path
  local_var_path = '/api/v2/engineering-insights/charts/deployments/frequency'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'projectKey'] = opts[:'project_key'] if !opts[:'project_key'].nil?
  query_params[:'environmentKey'] = opts[:'environment_key'] if !opts[:'environment_key'].nil?
  query_params[:'applicationKey'] = opts[:'application_key'] if !opts[:'application_key'].nil?
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
  query_params[:'bucketType'] = opts[:'bucket_type'] if !opts[:'bucket_type'].nil?
  query_params[:'bucketMs'] = opts[:'bucket_ms'] if !opts[:'bucket_ms'].nil?
  query_params[:'groupBy'] = opts[:'group_by'] if !opts[:'group_by'].nil?
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].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] || 'InsightsChart'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"InsightsChartsBetaApi.get_deployment_frequency_chart",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

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

#get_flag_status_chart(project_key, environment_key, opts = {}) ⇒ InsightsChart

Get flag status chart data Get flag status chart data. To learn more, read [Flag statuses](launchdarkly.com/docs/home/observability/flag-health#flag-statuses).

Parameters:

  • project_key (String) —

    The project key

  • environment_key (String) —

    The environment key

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

    the optional parameters

Options Hash (opts):

  • :application_key (String) —

    Comma separated list of application keys

Returns:



113
114
115
116
 
# File 'lib/launchdarkly_api/api/insights_charts_beta_api.rb', line 113

def get_flag_status_chart(project_key, environment_key, opts = {})
  data, _status_code, _headers = get_flag_status_chart_with_http_info(project_key, environment_key, opts)
  data
end

#get_flag_status_chart_with_http_info(project_key, environment_key, opts = {}) ⇒ Array<(InsightsChart, Integer, Hash)>

Get flag status chart data Get flag status chart data. To learn more, read [Flag statuses](launchdarkly.com/docs/home/observability/flag-health#flag-statuses).

Parameters:

  • project_key (String) —

    The project key

  • environment_key (String) —

    The environment key

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

    the optional parameters

Options Hash (opts):

  • :application_key (String) —

    Comma separated list of application keys

Returns:

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

    InsightsChart data, response status code and response headers



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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/launchdarkly_api/api/insights_charts_beta_api.rb', line 125

def get_flag_status_chart_with_http_info(project_key, environment_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InsightsChartsBetaApi.get_flag_status_chart ...'
  end
  # verify the required parameter 'project_key' is set
  if @api_client.config.client_side_validation && project_key.nil?
    fail ArgumentError, "Missing the required parameter 'project_key' when calling InsightsChartsBetaApi.get_flag_status_chart"
  end
  # verify the required parameter 'environment_key' is set
  if @api_client.config.client_side_validation && environment_key.nil?
    fail ArgumentError, "Missing the required parameter 'environment_key' when calling InsightsChartsBetaApi.get_flag_status_chart"
  end
  # resource path
  local_var_path = '/api/v2/engineering-insights/charts/flags/status'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'projectKey'] = project_key
  query_params[:'environmentKey'] = environment_key
  query_params[:'applicationKey'] = opts[:'application_key'] if !opts[:'application_key'].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] || 'InsightsChart'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"InsightsChartsBetaApi.get_flag_status_chart",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

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

#get_lead_time_chart(project_key, opts = {}) ⇒ InsightsChart

Get lead time chart data Get lead time chart data. The engineering insights UI displays lead time data in the [lead time metric view](launchdarkly.com/docs/home/observability/lead-time).

Parameters:

  • project_key (String) —

    The project key

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

    the optional parameters

Options Hash (opts):

  • :environment_key (String) —

    The environment key

  • :application_key (String) —

    Comma separated list of application keys

  • :from (Integer) —

    Unix timestamp in milliseconds. Default value is 7 days ago.

  • :to (Integer) —

    Unix timestamp in milliseconds. Default value is now.

  • :bucket_type (String) —

    Specify type of bucket. Options: &#x60;rolling&#x60;, &#x60;hour&#x60;, &#x60;day&#x60;. Default: &#x60;rolling&#x60;.

  • :bucket_ms (Integer) —

    Duration of intervals for x-axis in milliseconds. Default value is one day (&#x60;86400000&#x60; milliseconds).

  • :group_by (String) —

    Options: &#x60;application&#x60;, &#x60;stage&#x60;. Default: &#x60;stage&#x60;.

  • :expand (String) —

    Options: &#x60;metrics&#x60;, &#x60;percentiles&#x60;.

Returns:



193
194
195
196
 
# File 'lib/launchdarkly_api/api/insights_charts_beta_api.rb', line 193

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

#get_lead_time_chart_with_http_info(project_key, opts = {}) ⇒ Array<(InsightsChart, Integer, Hash)>

Get lead time chart data Get lead time chart data. The engineering insights UI displays lead time data in the [lead time metric view](launchdarkly.com/docs/home/observability/lead-time).

Parameters:

  • project_key (String) —

    The project key

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

    the optional parameters

Options Hash (opts):

  • :environment_key (String) —

    The environment key

  • :application_key (String) —

    Comma separated list of application keys

  • :from (Integer) —

    Unix timestamp in milliseconds. Default value is 7 days ago.

  • :to (Integer) —

    Unix timestamp in milliseconds. Default value is now.

  • :bucket_type (String) —

    Specify type of bucket. Options: &#x60;rolling&#x60;, &#x60;hour&#x60;, &#x60;day&#x60;. Default: &#x60;rolling&#x60;.

  • :bucket_ms (Integer) —

    Duration of intervals for x-axis in milliseconds. Default value is one day (&#x60;86400000&#x60; milliseconds).

  • :group_by (String) —

    Options: &#x60;application&#x60;, &#x60;stage&#x60;. Default: &#x60;stage&#x60;.

  • :expand (String) —

    Options: &#x60;metrics&#x60;, &#x60;percentiles&#x60;.

Returns:

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

    InsightsChart data, response status code and response headers



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
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/launchdarkly_api/api/insights_charts_beta_api.rb', line 211

def get_lead_time_chart_with_http_info(project_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InsightsChartsBetaApi.get_lead_time_chart ...'
  end
  # verify the required parameter 'project_key' is set
  if @api_client.config.client_side_validation && project_key.nil?
    fail ArgumentError, "Missing the required parameter 'project_key' when calling InsightsChartsBetaApi.get_lead_time_chart"
  end
  # resource path
  local_var_path = '/api/v2/engineering-insights/charts/lead-time'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'projectKey'] = project_key
  query_params[:'environmentKey'] = opts[:'environment_key'] if !opts[:'environment_key'].nil?
  query_params[:'applicationKey'] = opts[:'application_key'] if !opts[:'application_key'].nil?
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
  query_params[:'bucketType'] = opts[:'bucket_type'] if !opts[:'bucket_type'].nil?
  query_params[:'bucketMs'] = opts[:'bucket_ms'] if !opts[:'bucket_ms'].nil?
  query_params[:'groupBy'] = opts[:'group_by'] if !opts[:'group_by'].nil?
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].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] || 'InsightsChart'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"InsightsChartsBetaApi.get_lead_time_chart",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

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

#get_release_frequency_chart(project_key, environment_key, opts = {}) ⇒ InsightsChart

Get release frequency chart data Get release frequency chart data. Engineering insights displays release frequency data in the [release frequency metric view](launchdarkly.com/docs/home/observability/releases).

Parameters:

  • project_key (String) —

    The project key

  • environment_key (String) —

    The environment key

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

    the optional parameters

Options Hash (opts):

  • :application_key (String) —

    Comma separated list of application keys

  • :has_experiments (Boolean) —

    Filter events to those associated with an experiment (&#x60;true&#x60;) or without an experiment (&#x60;false&#x60;)

  • :global (String) —

    Filter to include or exclude global events. Default value is &#x60;include&#x60;. Options: &#x60;include&#x60;, &#x60;exclude&#x60;

  • :group_by (String) —

    Property to group results by. Options: &#x60;impact&#x60;

  • :from (Time) —

    Unix timestamp in milliseconds. Default value is 7 days ago.

  • :to (Time) —

    Unix timestamp in milliseconds. Default value is now.

  • :bucket_type (String) —

    Specify type of bucket. Options: &#x60;rolling&#x60;, &#x60;hour&#x60;, &#x60;day&#x60;. Default: &#x60;rolling&#x60;.

  • :bucket_ms (Integer) —

    Duration of intervals for x-axis in milliseconds. Default value is one day (&#x60;86400000&#x60; milliseconds).

  • :expand (String) —

    Options: &#x60;metrics&#x60;

Returns:



283
284
285
286
 
# File 'lib/launchdarkly_api/api/insights_charts_beta_api.rb', line 283

def get_release_frequency_chart(project_key, environment_key, opts = {})
  data, _status_code, _headers = get_release_frequency_chart_with_http_info(project_key, environment_key, opts)
  data
end

#get_release_frequency_chart_with_http_info(project_key, environment_key, opts = {}) ⇒ Array<(InsightsChart, Integer, Hash)>

Get release frequency chart data Get release frequency chart data. Engineering insights displays release frequency data in the [release frequency metric view](launchdarkly.com/docs/home/observability/releases).

Parameters:

  • project_key (String) —

    The project key

  • environment_key (String) —

    The environment key

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

    the optional parameters

Options Hash (opts):

  • :application_key (String) —

    Comma separated list of application keys

  • :has_experiments (Boolean) —

    Filter events to those associated with an experiment (&#x60;true&#x60;) or without an experiment (&#x60;false&#x60;)

  • :global (String) —

    Filter to include or exclude global events. Default value is &#x60;include&#x60;. Options: &#x60;include&#x60;, &#x60;exclude&#x60;

  • :group_by (String) —

    Property to group results by. Options: &#x60;impact&#x60;

  • :from (Time) —

    Unix timestamp in milliseconds. Default value is 7 days ago.

  • :to (Time) —

    Unix timestamp in milliseconds. Default value is now.

  • :bucket_type (String) —

    Specify type of bucket. Options: &#x60;rolling&#x60;, &#x60;hour&#x60;, &#x60;day&#x60;. Default: &#x60;rolling&#x60;.

  • :bucket_ms (Integer) —

    Duration of intervals for x-axis in milliseconds. Default value is one day (&#x60;86400000&#x60; milliseconds).

  • :expand (String) —

    Options: &#x60;metrics&#x60;

Returns:

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

    InsightsChart data, response status code and response headers



303
304
305
306
307
308
309
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
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/launchdarkly_api/api/insights_charts_beta_api.rb', line 303

def get_release_frequency_chart_with_http_info(project_key, environment_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InsightsChartsBetaApi.get_release_frequency_chart ...'
  end
  # verify the required parameter 'project_key' is set
  if @api_client.config.client_side_validation && project_key.nil?
    fail ArgumentError, "Missing the required parameter 'project_key' when calling InsightsChartsBetaApi.get_release_frequency_chart"
  end
  # verify the required parameter 'environment_key' is set
  if @api_client.config.client_side_validation && environment_key.nil?
    fail ArgumentError, "Missing the required parameter 'environment_key' when calling InsightsChartsBetaApi.get_release_frequency_chart"
  end
  # resource path
  local_var_path = '/api/v2/engineering-insights/charts/releases/frequency'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'projectKey'] = project_key
  query_params[:'environmentKey'] = environment_key
  query_params[:'applicationKey'] = opts[:'application_key'] if !opts[:'application_key'].nil?
  query_params[:'hasExperiments'] = opts[:'has_experiments'] if !opts[:'has_experiments'].nil?
  query_params[:'global'] = opts[:'global'] if !opts[:'global'].nil?
  query_params[:'groupBy'] = opts[:'group_by'] if !opts[:'group_by'].nil?
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
  query_params[:'bucketType'] = opts[:'bucket_type'] if !opts[:'bucket_type'].nil?
  query_params[:'bucketMs'] = opts[:'bucket_ms'] if !opts[:'bucket_ms'].nil?
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].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] || 'InsightsChart'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"InsightsChartsBetaApi.get_release_frequency_chart",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

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

#get_stale_flags_chart(project_key, environment_key, opts = {}) ⇒ InsightsChart

Get stale flags chart data Get stale flags chart data. Engineering insights displays stale flags data in the [flag health metric view](launchdarkly.com/docs/home/observability/flag-health). ### Expanding the chart response LaunchDarkly supports expanding the chart response to include additional fields. To expand the response, append the ‘expand` query parameter and include the following: * `metrics` includes details on the metrics related to stale flags For example, use `?expand=metrics` to include the `metrics` field in the response. By default, this field is not included in the response.

Parameters:

  • project_key (String) —

    The project key

  • environment_key (String) —

    The environment key

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

    the optional parameters

Options Hash (opts):

  • :application_key (String) —

    Comma separated list of application keys

  • :group_by (String) —

    Property to group results by. Options: &#x60;maintainer&#x60;

  • :maintainer_id (String) —

    Comma-separated list of individual maintainers to filter results.

  • :maintainer_team_key (String) —

    Comma-separated list of team maintainer keys to filter results.

  • :expand (String) —

    Options: &#x60;metrics&#x60;

Returns:



377
378
379
380
 
# File 'lib/launchdarkly_api/api/insights_charts_beta_api.rb', line 377

def get_stale_flags_chart(project_key, environment_key, opts = {})
  data, _status_code, _headers = get_stale_flags_chart_with_http_info(project_key, environment_key, opts)
  data
end

#get_stale_flags_chart_with_http_info(project_key, environment_key, opts = {}) ⇒ Array<(InsightsChart, Integer, Hash)>

Get stale flags chart data Get stale flags chart data. Engineering insights displays stale flags data in the [flag health metric view](launchdarkly.com/docs/home/observability/flag-health). ### Expanding the chart response LaunchDarkly supports expanding the chart response to include additional fields. To expand the response, append the &#x60;expand&#x60; query parameter and include the following: * &#x60;metrics&#x60; includes details on the metrics related to stale flags For example, use &#x60;?expand&#x3D;metrics&#x60; to include the &#x60;metrics&#x60; field in the response. By default, this field is not included in the response.

Parameters:

  • project_key (String) —

    The project key

  • environment_key (String) —

    The environment key

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

    the optional parameters

Options Hash (opts):

  • :application_key (String) —

    Comma separated list of application keys

  • :group_by (String) —

    Property to group results by. Options: &#x60;maintainer&#x60;

  • :maintainer_id (String) —

    Comma-separated list of individual maintainers to filter results.

  • :maintainer_team_key (String) —

    Comma-separated list of team maintainer keys to filter results.

  • :expand (String) —

    Options: &#x60;metrics&#x60;

Returns:

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

    InsightsChart data, response status code and response headers



393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'lib/launchdarkly_api/api/insights_charts_beta_api.rb', line 393

def get_stale_flags_chart_with_http_info(project_key, environment_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InsightsChartsBetaApi.get_stale_flags_chart ...'
  end
  # verify the required parameter 'project_key' is set
  if @api_client.config.client_side_validation && project_key.nil?
    fail ArgumentError, "Missing the required parameter 'project_key' when calling InsightsChartsBetaApi.get_stale_flags_chart"
  end
  # verify the required parameter 'environment_key' is set
  if @api_client.config.client_side_validation && environment_key.nil?
    fail ArgumentError, "Missing the required parameter 'environment_key' when calling InsightsChartsBetaApi.get_stale_flags_chart"
  end
  # resource path
  local_var_path = '/api/v2/engineering-insights/charts/flags/stale'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'projectKey'] = project_key
  query_params[:'environmentKey'] = environment_key
  query_params[:'applicationKey'] = opts[:'application_key'] if !opts[:'application_key'].nil?
  query_params[:'groupBy'] = opts[:'group_by'] if !opts[:'group_by'].nil?
  query_params[:'maintainerId'] = opts[:'maintainer_id'] if !opts[:'maintainer_id'].nil?
  query_params[:'maintainerTeamKey'] = opts[:'maintainer_team_key'] if !opts[:'maintainer_team_key'].nil?
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].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] || 'InsightsChart'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"InsightsChartsBetaApi.get_stale_flags_chart",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

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