Method: Censys::API#report

Defined in:
lib/censys/api.rb

#report(resource, params) ⇒ Object

Builds a report of aggregate data.

Parameters:

  • resource (:ipv4, :websites, :certificates)
  • params (Hash)

Options Hash (params):

  • :query (String) — default: **Required** —

    The query to perform.

  • :field (String) — default: **Required** —

    The field to aggregate.

  • :buckets (Fixnum) —

    Optional maximum number of values to be returned.

  • (Object)

Raises:

  • (ArgumentError) 


166
167
168
169
170
171
172
173
 
# File 'lib/censys/api.rb', line 166

def report(resource, params)
  raise(ArgumentError, "must specify the :query param") unless params[:query]
  raise(ArgumentError, "must specify the :field param") unless params[:field]

  post("/report/#{resource}", params) do |response|
    Report::Response.new(response)
  end
end