Create aggregate reports on the breakdown of a field in the result set of a query

The build report endpoint lets you run aggregate reports on the breakdown of a field in a result set analogous to the "Build Report" functionality in the front end. For example, if you wanted to determine the breakdown of cipher suites selected by Top Million Websites.

censys_report(index, query, field, buckets = 50)

Arguments

index

The search index to be queried. Must be one of either ipv4, websites, or certificates.

query

The query to be executed. For example, 80.http.get.headers.server: nginx.

field

The field you are running a breakdown on in "dot notation", e.g. location.country_code.

buckets

(optional) The maximum number of values to be returned in the report. Maximum: 500. Default: 50.

Value

list of information about the endpoint

Details

You must have both CENSYS_API_ID and CENSYS_API_SECRET present in the R environment for the functions in this package to work. It is highly suggested that you place those in ~/.Renviron at least for interactive work.

References

Censys search syntax: https://www.censys.io/ipv4/help; API doc: https://www.censys.io/api/v1/docs/report

Examples

## Not run: ------------------------------------
# censys_report("ipv4", "80.http.get.headers.server: Apache",
#               "location.country", 100)
## ---------------------------------------------