Get Metrics Summary

codegurusecurity_get_metrics_summary

R Documentation

Returns a summary of metrics for an account from a specified date, including number of open findings, the categories with most findings, the scans with most open findings, and scans with most open critical findings

Description

Returns a summary of metrics for an account from a specified date, including number of open findings, the categories with most findings, the scans with most open findings, and scans with most open critical findings.

Usage

codegurusecurity_get_metrics_summary(date)

Arguments

date

[required] The date you want to retrieve summary metrics from, rounded to the nearest day. The date must be within the past two years.

Value

A list with the following syntax:

list(
  metricsSummary = list(
    categoriesWithMostFindings = list(
      list(
        categoryName = "string",
        findingNumber = 123
      )
    ),
    date = as.POSIXct(
      "2015-01-01"
    ),
    openFindings = list(
      critical = 123.0,
      high = 123.0,
      info = 123.0,
      low = 123.0,
      medium = 123.0
    ),
    scansWithMostOpenCriticalFindings = list(
      list(
        findingNumber = 123,
        scanName = "string"
      )
    ),
    scansWithMostOpenFindings = list(
      list(
        findingNumber = 123,
        scanName = "string"
      )
    )
  )
)

Request syntax

svc$get_metrics_summary(
  date = as.POSIXct(
    "2015-01-01"
  )
)