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
See query parameters for details on the following parameters:
fields
format
Parameter | Description | Values |
---|---|---|
folder |
Show only companies in a specified folder. | [String] Folder unique identifier [folder_guid ]. See GET: Folder Details. |
quarters_back |
Get ratings from the last day of the # quarter(s) from today. | [Integer] |
rating_date |
Show only the latest rating date. | [String] The latest rating date [YYYY‑MM‑DD ]. |
show_ips |
Include only the organizations with visible IP addresses. | [Boolean] |
show_event_evidence |
Include only the organizations with enhanced event evidence. | [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_companyObject |
Contains the unique identifier of the country that your organization has set as its main country for monitoring purposes. | |
guidString [ entity_guid ] |
The unique identifier of your organization. | |
countriesArray |
Contains the monitored countries in your portfolio. Each country is a separate object. | |
guidString [ entity_guid ] |
The unique identifier of this company or country. | |
custom_idString |
A custom identifier assigned to this country by your organization. | |
nameString |
The name of this country. | |
shortnameString |
The country code of this country. | |
network_size_v4Integer |
The number of IPv4 addresses associated with the organizations attributed to this country. | |
ratingInteger |
The collective Bitsight Security Rating for the companies in this country. | |
rating_dateString [ YYYY‑MM‑DD ] |
The date when the Bitsight Security Rating for this company or country was generated. | |
date_addedString [ YYYY‑MM‑DD ] |
The date when this company or country was added to your National Cybersecurity portfolio. | |
industryNull |
This is irrelevant for National Cybersecurity. | |
industry_slugNull |
This is irrelevant for National Cybersecurity. | |
sub_industryNull |
This is irrelevant for National Cybersecurity. | |
sub_industry_slugNull |
This is irrelevant for National Cybersecurity. | |
typeString |
This value is always COUNTRY for National Cybersecurity. |
|
logoString |
The URL path of this country’s flag standard image, as displayed in the Bitsight platform. | |
sparklineString |
The URL path of the historical ratings trend line for this country. | |
external_idNull |
For internal Bitsight use. | |
subscription_typeString |
The type of subscription used to monitor this country. This value is always Countries for National Cybersecurity. |
|
subscription_type_keyString |
The slug name of the type of subscription used to monitor this company or country, for use as a reference with integrations. | |
primary_domainNull |
This is irrelevant for National Cybersecurity. | |
security_gradeNull |
This is irrelevant for National Cybersecurity. | |
grade_dateNull |
This is irrelevant for National Cybersecurity. | |
display_urlNull |
This is irrelevant for National Cybersecurity. | |
rating_dateString [ YYYY‑MM‑DD ] |
The date when the collective Bitsight Security Ratings for all companies in this National Cybersecurity portfolio were generated. | |
createdString [ YYYY‑MM‑DD ] |
The date when your National Cybersecurity portfolio was created. |
- September 25, 2020:
/v2/portfolio
now available.
Feedback
0 comments
Please sign in to leave a comment.