class SematextCloud::MetricsApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/SematextCloud/api/metrics_api.rb, line 19
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

list_data_series_using_post(app_id, request_body, opts = {}) click to toggle source

Get metrics data points for an app Default value of interval is 5m @param app_id appId @param request_body Metric data points request @param [Hash] opts the optional parameters @return [GenericApiResponse]

# File lib/SematextCloud/api/metrics_api.rb, line 28
def list_data_series_using_post(app_id, request_body, opts = {})
  data, _status_code, _headers = list_data_series_using_post_with_http_info(app_id, request_body, opts)
  data
end
list_data_series_using_post_with_http_info(app_id, request_body, opts = {}) click to toggle source

Get metrics data points for an app Default value of interval is 5m @param app_id appId @param request_body Metric data points request @param [Hash] opts the optional parameters @return [Array<(GenericApiResponse, Fixnum, Hash)>] GenericApiResponse data, response status code and response headers

# File lib/SematextCloud/api/metrics_api.rb, line 39
def list_data_series_using_post_with_http_info(app_id, request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MetricsApi.list_data_series_using_post ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling MetricsApi.list_data_series_using_post"
  end
  # verify the required parameter 'request_body' is set
  if @api_client.config.client_side_validation && request_body.nil?
    fail ArgumentError, "Missing the required parameter 'request_body' when calling MetricsApi.list_data_series_using_post"
  end
  # resource path
  local_var_path = '/spm-reports/api/v3/apps/{appId}/metrics/data'.sub('{' + 'appId' + '}', app_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(request_body)
  auth_names = ['api_key']
  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 => 'GenericApiResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MetricsApi#list_data_series_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
list_filters_using_post(app_id, request_body, opts = {}) click to toggle source

Get metrics filters and their values for an app Default value of interval is 5m @param app_id appId @param request_body Metric filters request @param [Hash] opts the optional parameters @return [GenericApiResponse]

# File lib/SematextCloud/api/metrics_api.rb, line 88
def list_filters_using_post(app_id, request_body, opts = {})
  data, _status_code, _headers = list_filters_using_post_with_http_info(app_id, request_body, opts)
  data
end
list_filters_using_post_with_http_info(app_id, request_body, opts = {}) click to toggle source

Get metrics filters and their values for an app Default value of interval is 5m @param app_id appId @param request_body Metric filters request @param [Hash] opts the optional parameters @return [Array<(GenericApiResponse, Fixnum, Hash)>] GenericApiResponse data, response status code and response headers

# File lib/SematextCloud/api/metrics_api.rb, line 99
def list_filters_using_post_with_http_info(app_id, request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MetricsApi.list_filters_using_post ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling MetricsApi.list_filters_using_post"
  end
  # verify the required parameter 'request_body' is set
  if @api_client.config.client_side_validation && request_body.nil?
    fail ArgumentError, "Missing the required parameter 'request_body' when calling MetricsApi.list_filters_using_post"
  end
  # resource path
  local_var_path = '/spm-reports/api/v3/apps/{appId}/metrics/filters'.sub('{' + 'appId' + '}', app_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(request_body)
  auth_names = ['api_key']
  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 => 'GenericApiResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MetricsApi#list_filters_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
list_metrics_keys_using_get(app_id, opts = {}) click to toggle source

Get metrics keys for an app @param app_id appId @param [Hash] opts the optional parameters @return [GenericApiResponse]

# File lib/SematextCloud/api/metrics_api.rb, line 146
def list_metrics_keys_using_get(app_id, opts = {})
  data, _status_code, _headers = list_metrics_keys_using_get_with_http_info(app_id, opts)
  data
end
list_metrics_keys_using_get_with_http_info(app_id, opts = {}) click to toggle source

Get metrics keys for an app @param app_id appId @param [Hash] opts the optional parameters @return [Array<(GenericApiResponse, Fixnum, Hash)>] GenericApiResponse data, response status code and response headers

# File lib/SematextCloud/api/metrics_api.rb, line 155
def list_metrics_keys_using_get_with_http_info(app_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MetricsApi.list_metrics_keys_using_get ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling MetricsApi.list_metrics_keys_using_get"
  end
  # resource path
  local_var_path = '/spm-reports/api/v3/apps/{appId}/metrics/keys'.sub('{' + 'appId' + '}', app_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'GenericApiResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MetricsApi#list_metrics_keys_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
list_metrics_using_get(app_id, opts = {}) click to toggle source

Get metrics info for an app @param app_id appId @param [Hash] opts the optional parameters @return [GenericApiResponse]

# File lib/SematextCloud/api/metrics_api.rb, line 198
def list_metrics_using_get(app_id, opts = {})
  data, _status_code, _headers = list_metrics_using_get_with_http_info(app_id, opts)
  data
end
list_metrics_using_get_with_http_info(app_id, opts = {}) click to toggle source

Get metrics info for an app @param app_id appId @param [Hash] opts the optional parameters @return [Array<(GenericApiResponse, Fixnum, Hash)>] GenericApiResponse data, response status code and response headers

# File lib/SematextCloud/api/metrics_api.rb, line 207
def list_metrics_using_get_with_http_info(app_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MetricsApi.list_metrics_using_get ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling MetricsApi.list_metrics_using_get"
  end
  # resource path
  local_var_path = '/spm-reports/api/v3/apps/{appId}/metrics'.sub('{' + 'appId' + '}', app_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'GenericApiResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MetricsApi#list_metrics_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end