Class: DatadogAPIClient::V2::DashboardsAPI

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of DashboardsAPI.



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

def api_client
  @api_client
end

Instance Method Details

#get_dashboard_usage(dashboard_id, opts = {}) ⇒ Object

Get usage stats for a dashboard.

See Also:



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

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

#get_dashboard_usage_with_http_info(dashboard_id, opts = {}) ⇒ Array<(DashboardUsageResponse, Integer, Hash)>

Get usage stats for a dashboard.

Get usage statistics for a single dashboard. The response includes view counts, the most recent view and edit times, widget counts, and the dashboard quality score.

Parameters:

  • dashboard_id (String) —

    The ID of the dashboard.

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

    the optional parameters

Returns:

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

    DashboardUsageResponse 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
92
93
94
95
 
# File 'lib/datadog_api_client/v2/api/dashboards_api.rb', line 41

def get_dashboard_usage_with_http_info(dashboard_id, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.get_dashboard_usage".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.get_dashboard_usage")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.get_dashboard_usage"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DashboardsAPI.get_dashboard_usage ...'
  end
  # verify the required parameter 'dashboard_id' is set
  if @api_client.config.client_side_validation && dashboard_id.nil?
    fail ArgumentError, "Missing the required parameter 'dashboard_id' when calling DashboardsAPI.get_dashboard_usage"
  end
  # resource path
  local_var_path = '/api/v2/dashboards/{dashboard_id}/usage'.sub('{dashboard_id}', CGI.escape(dashboard_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'])

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

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

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

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

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

#list_dashboards_usage(opts = {}) ⇒ Object

Get usage stats for all dashboards.

See Also:



100
101
102
103
 
# File 'lib/datadog_api_client/v2/api/dashboards_api.rb', line 100

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

#list_dashboards_usage_with_http_info(opts = {}) ⇒ Array<(ListDashboardsUsageResponse, Integer, Hash)>

Get usage stats for all dashboards.

Get paginated usage statistics for every dashboard in the caller's organization. Use page[limit] and page[offset] to walk the result set.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_limit (Integer) —

    Maximum number of dashboards to return per page. Server-side maximum is 500; values above 500 return a 400 Bad Request.

  • :page_offset (Integer) —

    Zero-based offset into the result set.

Returns:

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

    ListDashboardsUsageResponse data, 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
162
163
164
165
166
167
168
 
# File 'lib/datadog_api_client/v2/api/dashboards_api.rb', line 113

def list_dashboards_usage_with_http_info(opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.list_dashboards_usage".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.list_dashboards_usage")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.list_dashboards_usage"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DashboardsAPI.list_dashboards_usage ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page_offset'].nil? && opts[:'page_offset'] < 0
    fail ArgumentError, 'invalid value for "opts[:"page_offset"]" when calling DashboardsAPI.list_dashboards_usage, must be greater than or equal to 0.'
  end
  # resource path
  local_var_path = '/api/v2/dashboards/usage'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page[limit]'] = opts[:'page_limit'] if !opts[:'page_limit'].nil?
  query_params[:'page[offset]'] = opts[:'page_offset'] if !opts[:'page_offset'].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] || 'ListDashboardsUsageResponse'

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

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

#list_dashboards_usage_with_pagination(opts = {}) {|DashboardUsage| ... } ⇒ Object

Get usage stats for all dashboards.

Provide a paginated version of #list_dashboards_usage, returning all items.

To use it you need to use a block: list_dashboards_usage_with_pagination { |item| p item }

Yields:



177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/datadog_api_client/v2/api/dashboards_api.rb', line 177

def list_dashboards_usage_with_pagination(opts = {})
    api_version = "V2"
    page_size = @api_client.get_attribute_from_path(opts, "page_limit", 250)
    @api_client.set_attribute_from_path(api_version, opts, "page_limit", Integer, page_size)
    while true do
        response = list_dashboards_usage(opts)
        @api_client.get_attribute_from_path(response, "data").each { |item| yield(item) }
        if @api_client.get_attribute_from_path(response, "data").length < page_size
          break
        end
        @api_client.set_attribute_from_path(api_version, opts, "page_offset", Integer, @api_client.get_attribute_from_path(opts, "page_offset", 0) + page_size)
    end
end