Class: Falcon::SensorUsage

Inherits:
Object
  • Object
show all
Defined in:
lib/crimson-falcon/api/sensor_usage.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SensorUsage

Returns a new instance of SensorUsage.



36
37
38
 
# File 'lib/crimson-falcon/api/sensor_usage.rb', line 36

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



34
35
36
 
# File 'lib/crimson-falcon/api/sensor_usage.rb', line 34

def api_client
  @api_client
end

Instance Method Details

#get_sensor_usage_weekly(opts = {}) ⇒ ApiWeeklyAverageResponse

Fetches weekly average. Each data point represents the average of how many unique AIDs were seen per week for the previous 28 days.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    The FQL search filter. Allowed fields: "event_date" : A specified date that will be final date of the results returned. Specified date cannot be after the default. Format: '2024-06-11' Default: the current date, minus 2 days, in UTC "period" : An integer surrounded by single quotes representing the number of days to return. Format: '30' Default: '28' Minimum: '1' Maximum: '395' "selected_cids" : A comma separated list of CIDs to return data for. Caller must be a parent CID or have special access enabled. Format: 'cid_1,cid_2,cid_3' Default: for parent CIDs the default is the parent and all children, otherwise the current CID

Returns:



43
44
45
46
 
# File 'lib/crimson-falcon/api/sensor_usage.rb', line 43

def get_sensor_usage_weekly(opts = {})
  data, _status_code, _headers = get_sensor_usage_weekly_with_http_info(opts)
  data
end

#get_sensor_usage_weekly_with_http_info(opts = {}) ⇒ Array<(ApiWeeklyAverageResponse, Integer, Hash)>

Fetches weekly average. Each data point represents the average of how many unique AIDs were seen per week for the previous 28 days.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    The FQL search filter. Allowed fields: &quot;event_date&quot; : A specified date that will be final date of the results returned. Specified date cannot be after the default. Format: &#39;2024-06-11&#39; Default: the current date, minus 2 days, in UTC &quot;period&quot; : An integer surrounded by single quotes representing the number of days to return. Format: &#39;30&#39; Default: &#39;28&#39; Minimum: &#39;1&#39; Maximum: &#39;395&#39; &quot;selected_cids&quot; : A comma separated list of CIDs to return data for. Caller must be a parent CID or have special access enabled. Format: &#39;cid_1,cid_2,cid_3&#39; Default: for parent CIDs the default is the parent and all children, otherwise the current CID

Returns:

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

    ApiWeeklyAverageResponse data, response status code and response headers



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/crimson-falcon/api/sensor_usage.rb', line 52

def get_sensor_usage_weekly_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SensorUsage.get_sensor_usage_weekly ...'
  end
  # resource path
  local_var_path = '/billing-dashboards-usage/aggregates/weekly-average/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].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] || 'ApiWeeklyAverageResponse'

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

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