GET: Monitored Assets Summaries – Bitsight Knowledge Base

⇤ Portfolio

https://api.bitsighttech.com/ratings/v1/portfolio/monitored-assets/summaries

Get a summary of the critical assets you monitor.

Parameters
Example Request
Example Response
Response Attributes
Status Codes

Parameters

See query parameters for details on the following parameters:

*Required.

format (Default: ↻ json)
- csv
- json
- xml
limit (Default: ↻ 100)
offset (Default: ↻ 100)
q
sort

Parameter Values

fields

[Query] Filter by fields to return in response.

[String] Comma-separated strings. This endpoint accepts:

attributed_to
countries

threat.exposure_detection

[Query] Filter the monitored assets by those with a certain exposure detection.

[String] Threat unique identifier [threat_guid]. See GET: Portfolio Threats.

Requires threat.guid.

threat.guid

[Query] Filter the monitored assets by those affected by a given threat.

*Required for threat.exposure_detection.

[String] Threat unique identifier [threat_guid]. See GET: Portfolio Threats.

Example Request

curl https://api.bitsighttech.com/ratings/v1/portfolio/monitored-assets/summaries -u api_token:

Example Response

{
   “countries”: [
     {
       “code”: “US”,
       “name”: “United States”,
     },
       “code”: “ES”,
       “name”: “Spain”,
     …
   ],
   “attributed_to”: [
     {
       "guid":"abcd-def-ghi-1234",
       "name":"A Company"
     },
     {
       "guid":"def-ghi-1234-abcd",
       "name":"Different Company"
     },
     …
   ],
},

Response Attributes

Field		Description
countries Array		Lists all countries that exist in the customer’s portfolio of monitored assets.
	code String	The alpha-2 country code associated with the country.
	name String	The country name.
attributed_to Array		Lists all companies to which the monitored assets in your portfolio are attributed.
	guid String	The company guid.
	name String	The company name.

Status Codes

See the common errors and status codes.

Code: 500 – Server Not Available

Description: The threat parameter (threat.exposure_detection & threat.guid), which relies on an external service, is not available.

Troubleshooting: Remove the parameter and try again.

January 7, 2025: threat parameters.
September 30, 2024: Published.

Parameters

Example Request

Example Response

Response Attributes

Status Codes

Related articles