GET: Asset Risk Matrix

Ingrid

https://api.bitsighttech.com/ratings/v1/companies/company_guid/assets/statistics

This endpoint is the underlying data of the Asset Risk Matrix. It returns counts and the severity of security findings for a given company. This includes findings that were observed within the last 60 days.

Findings are grouped by the importance of the asset that the finds relate to, in a 3x3 (9 findings) or 4x4 matrix (16 findings).

Parameters

* Required.

See query parameters for details on the format (value: json) parameter.

company_guid

* Required.

[Path] Identify the company to query.

Value: [String] Company unique identifier [entity_guid]. See GET: Portfolio Details.

Example Request

curl https://api.bitsighttech.com/ratings/v1/companies/a940bb61-33c4-42c9-9231-c8194c305db3/assets/statistics?format=json -u api_token:

Example Response

{
  "assets": [
    {
      "asset": "foobar.com",
      "importance": 0,
      "importance_category": "low",
      "stats": {
        "grades": {
          "total": 2,
          "good": 1,
          "fair": 0,
          "warn": 0,
          "bad": 0,
          "neutral": 1,
          "na": 0
        }
      },
      "tags": [ ]
    },
    […]
  ],
  "stats": {
    "critical": {
      "grades": {
        "total": 33,
        "good": 11,
        "fair": 18,
        "warn": 4,
        "bad": 0,
        "neutral": 0,
        "na": 0
      }
    },
    […]
  }
}

Response Attributes

Field			Description
assets Object			The list of assets for the company and a summary of the findings information within those assets.
	asset String		The name of the asset.
	importance Integer		The numeric importance of the asset to the organization.
	importance_category String		The importance category of the asset. Learn more about asset importance and finding severity.
	stats Object		A summary of statistics about the findings in the asset.
		grades String	The finding grade for which summary statistics will be generated from.
		total Integer	The number of findings that’s related to the asset.
		good Integer	The number of findings that’s related to the asset with the grade, “good.”
		fair Integer	The number of findings that’s related to the asset with the grade, “fair.”
		warn Integer	The number of findings that’s related to the asset with the grade, “warn.”
		bad Integer	The number of findings that’s related to the asset with the grade, “bad.”
		neutral Integer	The number of findings that’s related to the asset with the grade, “neutral.”
		na Integer	The number of findings that’s related to the asset with the grade, “N/A.”
stats Object			A summary of findings for each category of asset importance in the company. The number and names of the importance categories depend whether the asset risk matrix is configured to be 3x3 or 4x4. Learn more about customizing the asset risk matrix.
	Asset Importance Category String		The name of the importance category for which the findings summary statistics are calculated. The names of the importance categories depend whether the asset risk matrix is configured to be 3x3 or 4x4. Learn more about customizing the asset risk matrix.
		grades Object	The findings grade for which the summary statistics will be generated from.
		total Integer	The number of findings for the company that’s related to the asset importance category.
		good Integer	The number of findings for the company that’s related to the asset importance category, with the grade, “good.”
		fair Integer	The number of findings for the company that’s related to the asset importance category, with the grade, “fair.”
		warn Integer	The number of findings for the company that’s related to the asset importance category, with the grade, “warn.”
		bad Integer	The number of findings for the company that’s related to the asset importance category, with the grade, “bad.”
		neutral Integer	The number of findings for the company that’s related to the asset importance category, with the grade, “neutral.”
		na Integer	The number of findings for the company that’s related to the asset importance category, with the grade, “N/A.”

Status Codes

See the common errors and status codes.

March 19, 2021: Filter by Compromised Systems and User Behavior finding grades (N/A).
September 10, 2019: Published.