GET: Monitored Assets Summaries

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

fields

[Query] Filter by fields to return in response.

Value: [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.

Value: [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.

Value: [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

countries

code

name

attributed_to

guid

name

Status Codes

See the common errors and status codes.

500 – Server Not Available

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

Troubleshooting: Remove the parameter and try again.