GET: Findings in a Folder

Ingrid

https://api.bitsighttech.com/ratings/v1/folders/folder_guid/findings/summary

See the presence of findings in a folder.

Parameters

* Required.

folder_guid

* Required.

[Path] Identify the folder to query.

Value: [String] Folder unique identifier [folder_guid]. See GET: Folder Details.

type

[Query] Filter by risk type.

Value: [String] Risk type slug name. See risk types.

confidence

[Query] Risk confidence.

Value: [String]

LOW
HIGH

Example Request

curl https://api.bitsighttech.com/ratings/v1/folders/folder_guid/findings/summary -u api_token:

Example Response

[
  {
    "start_date":"2020-05-01",
    "end_date":"2020-06-30",
    "stats":[
      {
        "id":"CVE-2012-2532",
        "name":"CVE-2012-2532",
        "count":1,
        "severity":null,
        "severity_category":null,
        "confidence":"LOW"
      }
    ]
  }
]

Response Attributes

Field			Description
start_date String [`YYYY‑MM‑DD`]			The beginning date of this summary.
end_date String [`YYYY‑MM‑DD`]			The ending date of this summary.
stats Array			Folder statistics.
	Object		Details of a vulnerability.
		id String	The Common Vulnerabilities and Exposures (CVE) ID of prominent vulnerabilities, to be used in web searches or in the National Vulnerability Database (NVD) for more information about the vulnerability in question.
		name String	The CVE ID or vulnerability name if available (e.g., BlueKeep).
		count Integer	This value is always `1` for folder statistics.
		severity Null	For internal Bitsight use.
		severity_category Null	For internal Bitsight use.
		confidence String	Risk confidence level. `LOW` `HIGH`

July 2, 2020: Published.