Security Performance Management
Continuous Monitoring
Cyber Insurance
National Cybersecurity

Articles in this section

GET: KPI for National Cybersecurity Observations

Avatar
Ingrid
Follow
  • August 1, 2019: date_interval parameter, “30d” changed to “7d.”

⇤ National Cybersecurity

https://api.bitsighttech.com/sovereign/observations/kpis/

Use this to retrieve top infections, top vulnerabilities, and most common open ports for subscribed countries.

This endpoint is only available for users with access to the National Cybersecurity app. It only returns information for countries you subscribe to.

Parameters

See query parameters for details on the limit (default: all) parameter.

Parameter Description Values 
country
Query		 Filter by company or country. [String] Company or country unique identifier [entity_guid]. See GET: National Cybersecurity Portfolio Details. 
date_interval
Query		 Limit included observations by date interval. [String]
  • 7d (Default)
  • 30d
 
industry
Query		 Filter observations by the selected industry. [String] Industry name. See industries. 
order
Query		 Sort results in ascending or descending order. [String]
  • asc
  • desc (Default)

Example Request

curl https://api.bitsighttech.com/sovereign/observations/kpis/?country=5d04c480-b1e7-48af-9633-82996a8446fc -u api_token: | jq

Example Response

{
  "scope": {
    "type": "country",
    "value": "FO"
  },
  "kpis": {
    "vulnerabilities": [
      {
        "ipPercentageKpi": 30.365662,
        "name": "Logjam"
      },
      {
        "ipPercentageKpi": 15.580286,
        "name": "POODLE"
      }
    ],
    "infections": [
      {
        "ipPercentageKpi": 37.79707,
        "name": "Ztorg"
      },
      {
        "ipPercentageKpi": 32.92116,
        "name": "Uupay"
      }
    ],
    "open_ports": [
      {
        "ipPercentageKpi": 0.009383503,
        "name": "Port 3389"
      },
      {
        "ipPercentageKpi": 0.009383503,
        "name": "IRC"
      }
    ]
  }
}

Response Attributes

Field Description 
scope
Object		  
  
type
String		 For internal Bitsight use. 
value
String		 The two-letter country code of the company's country. 
kpis
Object		 KPI details.
  
vulnerabilities
Array		 Vulnerability details of this country.
  
ipPercentageKpi
Decimal		 The percentage of all observed vulnerabilities in the country that are made up of this vulnerability. 
name
String		 The name of the vulnerability (CVE or named vulnerability). 
infections
Array		 Infection details of this country.
  
ipPercentageKpi
Decimal		 The percentage of all observed infections in the country that are made up of this vulnerability. 
name
String		 The botnet name. 
open_ports
Array		 Open port details of this country.
  
ipPercentageKpi
Decimal		 The percentage of all observed ports in the country that are open. 
name
String		 The name of the service associated with the port or port number.

Related articles