GET: KPI for National Cybersecurity Observations

Ingrid

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
Example Request
Example Response
Response Attributes

Parameters

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

Parameter Values

Parameter	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` `30d`
industry [Query] Filter observations by the selected industry.	[String] Industry name. Use GET: Industries with the `show_all` parameter set to `true` [`/v1/industries?show_all=true`].
order [Query] Sort results in ascending or descending order.	[String] `asc` ↻ `desc`

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
30d

industry

[Query] Filter observations by the selected industry.

[String] Industry name. Use GET: Industries with the show_all parameter set to true [/v1/industries?show_all=true].

order

[Query] Sort results in ascending or descending order.

[String]

asc
↻ desc

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.

December 5, 2023: How to get the industry name.
August 1, 2019: date_interval parameter, “30d” changed to “7d.”