Security Performance Management
Continuous Monitoring
Cyber Insurance
National Cybersecurity

Articles in this section

See more

GET: Asset Summaries

Avatar
Ingrid
Follow
Publication Date – March 10, 2023

⇤ Companies

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

Summarized asset data for a company in your ratings tree.

Parameters

*Required.

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

Parameter Description Values 
guid
Query 		Identify the company to query. [String] Company unique identifier [entity_guid]. See GET: Portfolio Details.

Example Response

{
  "services":[
    […]
    {
      "name":"TLS requiring Client Certificate",
      "findings":{
        "total_count":10,
        "counts_by_severity":{
          "severe":0,
          "material":0,
          "moderate":0,
          "minor":10
        }
      },
      "assets":{
        "total_count":10,
        "counts_by_importance":{
          "critical":0,
          "high":0,
          "medium":0,
          "low":10,
          "none":0
        }
      }
    }
  ],
  "hosted_by":[
    […]
    {
      "guid":"6c9ee89a-f27c-43fc-b8bb-3534c6fc57a4",
      "name":"Vodafone Group of Companies",
      "findings":{
        "total_count":0,
        "counts_by_severity":{
          "severe":0,
          "material":0,
          "moderate":0,
          "minor":0
        }
      },
      "assets":{
        "total_count":1,
        "counts_by_importance":{
          "critical":0,
          "high":0,
          "medium":0,
          "low":1,
          "none":0
        }
      }
    }
  ],
  "origin_subsidiaries":[
    […]
    {
      "guid":"a940bb61-33c4-42c9-9231-c8194c305db3",
      "name":"Saperix, Inc.",
      "findings":{
        "total_count":343,
        "counts_by_severity":{
          "severe":42,
          "material":33,
          "moderate":52,
          "minor":216
        }
      },
      "assets":{
        "total_count":140,
        "counts_by_importance":{
          "critical":75,
          "high":12,
          "medium":10,
          "low":43,
          "none":0
        }
      }
    }
  ],
  "countries":[
    […]
    {
      "code":"US",
      "name":"United States",
      "findings":{
        "total_count":691,
        "counts_by_severity":{
          "severe":41,
          "material":248,
          "moderate":114,
          "minor":288
        }
      },
      "assets":{
        "total_count":166,
        "counts_by_importance":{
          "critical":22,
          "high":17,
          "medium":9,
          "low":117,
          "none":1
        }
      }
    }
  ],
  "categories":[
    […]
    {
      "name":"Web Content",
      "assets":{
        "critical":11,
        "high":7,
        "medium":9,
        "low":2615,
        "none":0,
        "total_asset_count":2642
      },
      "service_list":[
      "HTTPS/Java"
      ]
    }
  ],
  "products":[
    […]
    {
      "vendor":"wordpress",
      "product":[
        […]
        {
          "version":"5.8.4",
          "name":"wordpress",
          "support":"unknown",
          "assets":{
            "counts_by_importance":{
              "critical":0,
              "high":0,
              "medium":0,
              "low":1,
              "none":0
            },
            "total_count":1
          }
        }
      ]
    }
  ]
}

Response Attributes

Field Description 
services
Array 		Services used by the asset.
  Object A service and its details.
  
name
String 		The name of this service. 
findings
Object 		The service’s finding details.
  
total_count
Integer 		The number of findings. 
counts_by_severity
Object 		Findings grouped by finding severity.
  
severe
Integer 		The number of severe-severity findings. 
material
Integer 		The number of material-severity findings. 
moderate
Integer 		The number of moderate-severity findings. 
minor
Integer 		The number of minor-severity findings. 
assets
Object 		The service’s asset details.
  
total_count
Integer 		The number of assets. 
counts_by_importance
Object 		Assets by asset importance.
  
critical
Integer 		The number of critical-importance assets. 
high
Integer 		The number of high-importance assets. 
medium
Integer 		The number of medium-importance assets. 
low
Integer 		The number of low-importance assets. 
none
Integer 		The number of unassigned-importance assets. 
hosted_by
Array 		Host details.
  Object The host and its details.
  
guid
String [entity_guid]		 The host’s unique identifier. 
name
String 		The hostname. 
findings
Object 		The host’s findings.
  
total_count
Integer 		The number of findings. 
counts_by_severity
Object 		The number of findings grouped by finding severity.
  
severe
Integer 		The number of severe-severity findings. 
material
Integer 		The number of material-severity findings. 
moderate
Integer 		The number of moderate-severity findings. 
minor
Integer 		The number of minor-severity findings. 
assets
Object 		The host’s assets.
  
total_count
Integer 		The number of assets. 
counts_by_importance
Object 		The number of assets grouped by asset importance.
  
critical
Integer 		The number of critical-importance assets. 
high
Integer 		The number of high-importance assets. 
medium
Integer 		The number of medium-importance assets. 
low
Integer 		The number of low-importance assets. 
none
Integer 		The number of unassigned-importance assets. 
origin_subsidiaries
Array 		Subsidiaries and their details.
  Object A subsidiary.
  
guid
String [entity_guid]		 This subsidiary’s unique identifier. 
name
String 		This subsidiary’s name.
  
findings
Object 		Findings attributed to this subsidiary.
  
total_count
Integer 		The number of findings. 
counts_by_severity
Object 		Findings by finding severity.
  
severe
Integer 		The number of severe-severity findings. 
material
Integer 		The number of material-severity findings. 
moderate
Integer 		The number of moderate-severity findings. 
minor
Integer 		The number of minor-severity findings. 
assets
Object 		Assets attributed to this subsidiary.
  
total_count
Integer 		The number of assets. 
counts_by_importance
Object 		Assets by asset importance.
  
critical
Integer 		The number of critical-importance assets. 
high
Integer 		The number of high-importance assets. 
medium
Integer 		The number of medium-importance assets. 
low
Integer 		The number of low-importance assets. 
none
Integer 		The number of unassigned-importance assets. 
countries
Array 		Assets by country.
  Object A country.
  
code
String 		This country’s two-letter country code. 
name
String 		This country’s name. 
findings
Object 		Findings attributed to this country.
  
total_count
Integer 		The number of findings. 
counts_by_severity
Object 		Findings grouped by finding severity.
  
severe
Integer 		The number of severe-severity findings. 
material
Integer 		The number of material-severity findings. 
moderate
Integer 		The number of moderate-severity findings. 
minor
Integer 		The number of minor-severity findings. 
assets
Object 		This country’s assets.
  
total_count
Integer 		The number of assets. 
counts_by_importance
Object 		Assets grouped by asset importance.
  
critical
Integer 		The number of critical-importance assets. 
high
Integer 		The number of high-importance assets. 
medium
Integer 		The number of medium-importance assets. 
low
Integer 		The number of low-importance assets. 
none
Integer 		The number of unassigned-importance assets. 
categories
Array 		A category’s assets.
  Object A category.
  
name
String 		This category’s name. 
assets
Object 		Assets grouped by asset importance.
  
critical
Integer 		The number of critical-importance assets. 
high
Integer 		The number of high-importance assets. 
medium
Integer 		The number of medium-importance assets. 
low
Integer 		The number of low-importance assets. 
none
Integer 		The number of unassigned-importance assets. 
total_asset_count
Integer 		The number of assets attributed to this category. 
service_list
Array 		Services running on this asset. 
products
Array 		Assets attributed to a service provider product.
  Object A product.
  
vendor
String 		The service provider. 
product
Array 		Products and their details.
  Object A product.
  
version
String 		The software version. 
name
String 		The software name. 
support
String 		The software’s support status. 
assets
Object 		Assets attributed to the product.
  
counts_by_importance
Object 		Assets grouped by asset importance.
  
critical
Integer 		The number of critical-importance assets. 
high
Integer 		The number of high-importance assets. 
medium
Integer 		The number of medium-importance assets. 
low
Integer 		The number of low-importance assets. 
none
Integer 		The number of unassigned-importance asset 
total_count
Integer 		The number of assets.

Response Codes

See the common errors and status codes.

Code Description
200 – Okay Everything worked as expected.
404 – Not Found The specified resource does not exist or could not be found.

Related articles