GET: National Cybersecurity Portfolio Details [v1]

Ingrid

https://api.bitsighttech.com/ratings/v1/portfolio

Get information regarding your National Cybersecurity portfolio.

Subscriptions that are not National Cybersecurity accounts (Enterprise, Insurance, etc.) will receive information about companies in their portfolio. See GET: Portfolio Details for details.

Version 2 is now available, which includes pagination, improved performance, and enhanced filters. Going forward, all new functionality will be added to the /v2/portfolio endpoint.

Parameters
Example Request
Example Response
Response Attributes

Parameters

See query parameters for details on the following parameters:

fields
format

folder

Show only companies in a specified folder.

Value: [String] Folder unique identifier [folder_guid]. See GET: Folder Details.

quarters_back

Get ratings from the last day of the # quarter(s) from today.

Value: [Integer]

rating_date

Show only the latest rating date.

Value: [String] The latest rating date [YYYY‑MM‑DD].

show_ips

Include only the organizations with visible IP addresses.

Value: [Boolean]

show_event_evidence

Include only the organizations with enhanced event evidence.

Value: [Boolean]

Example Request

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

Example Request (with jq)

curl https://api.bitsighttech.com/ratings/v1/portfolio -u api_token: | jq .countries

Example Response

{
  "my_company":{
    "guid":"a940bb61-33c4-42c9-9231-c8194c305db3"
  },
  "countries":[
    {
      "guid":"cccccccc-7777-cccc-7777-cccccccccccc",
      "custom_id":null,
      "name":"Example Nation",
      "shortname":"XN",
      "network_size_v4":0,
      "rating":550,
      "rating_date":"2019-10-19",
      "date_added":"2019-06-26",
      "industry":null,
      "industry_slug":null,
      "sub_industry":null,
      "sub_industry_slug":null,
      "type":"COUNTRY",
      "logo":"https://api.bitsighttech.com/ratings/v1/companies/cccccccc-7777-cccc-7777-cccccccccccc/logo-image",
      "sparkline":"https://api.bitsighttech.com/ratings/v1/companies/cccccccc-7777-cccc-7777-cccccccccccc/sparkline?size=small",
      "external_id":null,
      "subscription_type":"Countries",
      "subscription_type_key":"countries",
      "primary_domain":null,
      "security_grade":null,
      "grade_date":null,
      "display_url":null
    }
  ],
  "rating_date":"2019-10-19",
  "created":"2012-10-31"
}

Response Attributes

These are the attributes of a National Cybersecurity object in the Bitsight API.

Field		Description
my_company Object		Contains the unique identifier of the country that your organization has set as its main country for monitoring purposes.
	guid String [`entity_guid`]	The unique identifier of your organization.
countries Array		Contains the monitored countries in your portfolio. Each country is a separate object.
	guid String [`entity_guid`]	The unique identifier of this company or country.
	custom_id String	A custom identifier assigned to this country by your organization.
	name String	The name of this country.
	shortname String	The country code of this country.
	network_size_v4 Integer	The number of IPv4 addresses associated with the organizations attributed to this country.
	rating Integer	The collective Bitsight Security Rating for the companies in this country.
	rating_date String [`YYYY‑MM‑DD`]	The date when the Bitsight Security Rating for this company or country was generated.
	date_added String [`YYYY‑MM‑DD`]	The date when this company or country was added to your National Cybersecurity portfolio.
	industry Null	This is irrelevant for National Cybersecurity.
	industry_slug Null	This is irrelevant for National Cybersecurity.
	sub_industry Null	This is irrelevant for National Cybersecurity.
	sub_industry_slug Null	This is irrelevant for National Cybersecurity.
	type String	This value is always `COUNTRY` for National Cybersecurity.
	logo String	The URL path of this country’s flag standard image, as displayed in the Bitsight platform.
	sparkline String	The URL path of the historical ratings trend line for this country.
	external_id Null	For internal Bitsight use.
	subscription_type String	The type of subscription used to monitor this country. This value is always `Countries` for National Cybersecurity.
	subscription_type_key String	The slug name of the type of subscription used to monitor this company or country, for use as a reference with integrations.
	primary_domain Null	This is irrelevant for National Cybersecurity.
	security_grade Null	This is irrelevant for National Cybersecurity.
	grade_date Null	This is irrelevant for National Cybersecurity.
	display_url Null	This is irrelevant for National Cybersecurity.
rating_date String [`YYYY‑MM‑DD`]		The date when the collective Bitsight Security Ratings for all companies in this National Cybersecurity portfolio were generated.
created String [`YYYY‑MM‑DD`]		The date when your National Cybersecurity portfolio was created.

September 25, 2020: /v2/portfolio now available.