GET: National Cybersecurity Companies KPI – Bitsight Knowledge Base

Publication Date – November 8, 2021

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

See observation distinct company counts for each supported filter.

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

Parameters
- Scope Filtering
- Data Filtering
Example Request
Example Response
Response Attributes

Parameters

Scope Filtering

If no scope is set, your country is used as scope. An IP or a country-industry can be alternatively used, but not both (country & IP or country & country-industry) simultaneously.

Parameter		Description	Values
country_codes Query		Filter by multiple countries.	[Array] Comma-separated 2-letter country codes.
Date		Filter by dates. To get historical data between two dates, ensure the `history` parameter is set to `true` (`history=true`).
	end_date Query	Filter by end date.	[String] `YYYY-MM-DD`
	start_date Query	Filter by start date.	[String] `YYYY-MM-DD`
date_interval		Filter by date interval.	[String] `7d` (Default) `30d`
industries Query		Filter by multiple industries.	[Array] Comma-separated industry names. See industries.
ips Query		Filter by multiple IPV4 or IPV6 addresses.	[Array] Comma-separated IP addresses. IPv4 Address (Dotted Notation) IPv6 Address
limit		Set the maximum number of results.	[Integer] A number greater than `0` (zero).

Data Filtering

Parameter	Description	Values
categories Query	Filter by file sharing category (User Behavior).	[Array] Comma-separated File Sharing category names.
infections	Filter by infections.	[Array] Comma-separated infection names. See `infections` in GET: National Cybersecurity Observation Details by Risk Type.
open_ports Query	Filter by network services.	[Array] Comma-separated port numbers or service names. See `service` in GET: National Cybersecurity Observation Details by Risk Type. This is case-sensitive.
risk_types Query	Filter by risk types.	[Array] Comma-separated risk type slug names. See risk types.
vulnerabilities Query	Filter by vulnerabilities.	[String] Comma-separated vulnerability names or CVE ID.
vulnerability_classification Query	Filter by vulnerability confidence level. Only applicable with the `vulnerabilities` parameter.	[String] `Potential` = Low confidence/potential vulnerabilities. `Confirmed` = High confidence or confirmed vulnerabilities. `All` (Default) = All vulnerabilities, regardless of confidence level.

Example Request

curl 'https://api.bitsighttech.com/sovereign/observations/companies/kpis/' -u api_token:

Example Response

{
  "scope":{
    "type":"country",
    "value":"A1",
    "date_interval":"7d",
    "end_date":"2021-10-20"
  },
  "included_companies":3,
  "total_companies":3,
  "companies":[
    {
      "company":{
        "name":"Saperix, Inc.",
        "guid":"a940bb61-33c4-42c9-9231-c8194c305db3",
        "industry_sector":"Telecommunications",
        "in_portfolio":false,
        "sub_industry":"Telecommunications"
      },
      "count":12345
    }
  ]
}

Response Attributes

Field				Description
scope Object				Company KPI details of the requested country.
	type String			For internal Bitsight use.
	value String			The 2-letter country code of the requested country.
	date_interval String			The date interval.
	end_date String [`YYYY‑MM‑DD`]			The ending date of the interval.
included_companies Integer				The number of queried companies.
total_companies Integer				The total number of companies in the country.
companies Array				Company KPI details.
	Object			A company.
		company Object		Details of this company.
			name String	The name of this company.
			guid String [`entity_guid`]	The unique identifier of this company.
			industry_sector String	The industry of this company.
			in_portfolio Boolean	`true` = You are subscribed to this company and it’s in your portfolio.
			sub_industry String	The sub-industry of this company.
		count Integer		The total number of results.

Articles in this section