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 | 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 | ||||||
---|---|---|---|---|---|---|---|
servicesArray |
Services used by the asset. | ||||||
Object | A service and its details. | ||||||
nameString |
The name of this service. | ||||||
findingsObject |
The service’s finding details. | ||||||
total_countInteger |
The number of findings. | ||||||
counts_by_severityObject |
Findings grouped by finding severity. | ||||||
severeInteger |
The number of severe-severity findings. | ||||||
materialInteger |
The number of material-severity findings. | ||||||
moderateInteger |
The number of moderate-severity findings. | ||||||
minorInteger |
The number of minor-severity findings. | ||||||
assetsObject |
The service’s asset details. | ||||||
total_countInteger |
The number of assets. | ||||||
counts_by_importanceObject |
Assets by asset importance. | ||||||
criticalInteger |
The number of critical-importance assets. | ||||||
highInteger |
The number of high-importance assets. | ||||||
mediumInteger |
The number of medium-importance assets. | ||||||
lowInteger |
The number of low-importance assets. | ||||||
noneInteger |
The number of unassigned-importance assets. | ||||||
hosted_byArray |
Host details. | ||||||
Object | The host and its details. | ||||||
guidString [ entity_guid ] |
The host’s unique identifier. | ||||||
nameString |
The hostname. | ||||||
findingsObject |
The host’s findings. | ||||||
total_countInteger |
The number of findings. | ||||||
counts_by_severityObject |
The number of findings grouped by finding severity. | ||||||
severeInteger |
The number of severe-severity findings. | ||||||
materialInteger |
The number of material-severity findings. | ||||||
moderateInteger |
The number of moderate-severity findings. | ||||||
minorInteger |
The number of minor-severity findings. | ||||||
assetsObject |
The host’s assets. | ||||||
total_countInteger |
The number of assets. | ||||||
counts_by_importanceObject |
The number of assets grouped by asset importance. | ||||||
criticalInteger |
The number of critical-importance assets. | ||||||
highInteger |
The number of high-importance assets. | ||||||
mediumInteger |
The number of medium-importance assets. | ||||||
lowInteger |
The number of low-importance assets. | ||||||
noneInteger |
The number of unassigned-importance assets. | ||||||
origin_subsidiariesArray |
Subsidiaries and their details. | ||||||
Object | A subsidiary. | ||||||
guidString [ entity_guid ] |
This subsidiary’s unique identifier. | ||||||
nameString |
This subsidiary’s name. | ||||||
findingsObject |
Findings attributed to this subsidiary. | ||||||
total_countInteger |
The number of findings. | ||||||
counts_by_severityObject |
Findings by finding severity. | ||||||
severeInteger |
The number of severe-severity findings. | ||||||
materialInteger |
The number of material-severity findings. | ||||||
moderateInteger |
The number of moderate-severity findings. | ||||||
minorInteger |
The number of minor-severity findings. | ||||||
assetsObject |
Assets attributed to this subsidiary. | ||||||
total_countInteger |
The number of assets. | ||||||
counts_by_importanceObject |
Assets by asset importance. | ||||||
criticalInteger |
The number of critical-importance assets. | ||||||
highInteger |
The number of high-importance assets. | ||||||
mediumInteger |
The number of medium-importance assets. | ||||||
lowInteger |
The number of low-importance assets. | ||||||
noneInteger |
The number of unassigned-importance assets. | ||||||
countriesArray |
Assets by country. | ||||||
Object | A country. | ||||||
codeString |
This country’s two-letter country code. | ||||||
nameString |
This country’s name. | ||||||
findingsObject |
Findings attributed to this country. | ||||||
total_countInteger |
The number of findings. | ||||||
counts_by_severityObject |
Findings grouped by finding severity. | ||||||
severeInteger |
The number of severe-severity findings. | ||||||
materialInteger |
The number of material-severity findings. | ||||||
moderateInteger |
The number of moderate-severity findings. | ||||||
minorInteger |
The number of minor-severity findings. | ||||||
assetsObject |
This country’s assets. | ||||||
total_countInteger |
The number of assets. | ||||||
counts_by_importanceObject |
Assets grouped by asset importance. | ||||||
criticalInteger |
The number of critical-importance assets. | ||||||
highInteger |
The number of high-importance assets. | ||||||
mediumInteger |
The number of medium-importance assets. | ||||||
lowInteger |
The number of low-importance assets. | ||||||
noneInteger |
The number of unassigned-importance assets. | ||||||
categoriesArray |
A category’s assets. | ||||||
Object | A category. | ||||||
nameString |
This category’s name. | ||||||
assetsObject |
Assets grouped by asset importance. | ||||||
criticalInteger |
The number of critical-importance assets. | ||||||
highInteger |
The number of high-importance assets. | ||||||
mediumInteger |
The number of medium-importance assets. | ||||||
lowInteger |
The number of low-importance assets. | ||||||
noneInteger |
The number of unassigned-importance assets. | ||||||
total_asset_countInteger |
The number of assets attributed to this category. | ||||||
service_listArray |
Services running on this asset. | ||||||
productsArray |
Assets attributed to a service provider product. | ||||||
Object | A product. | ||||||
vendorString |
The service provider. | ||||||
productArray |
Products and their details. | ||||||
Object | A product. | ||||||
versionString |
The software version. | ||||||
nameString |
The software name. | ||||||
supportString |
The software’s support status. | ||||||
assetsObject |
Assets attributed to the product. | ||||||
counts_by_importanceObject |
Assets grouped by asset importance. | ||||||
criticalInteger |
The number of critical-importance assets. | ||||||
highInteger |
The number of high-importance assets. | ||||||
mediumInteger |
The number of medium-importance assets. | ||||||
lowInteger |
The number of low-importance assets. | ||||||
noneInteger |
The number of unassigned-importance asset | ||||||
total_countInteger |
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. |
March 10, 2023: Published.
Feedback
0 comments
Please sign in to leave a comment.