- February 5, 2020: Use the
/portfolio
endpoint to get information about companies in your portfolio.
https://api.bitsighttech.com/ratings/v1/companies
This endpoint returns several informational keys, an array of objects (each of which contains details about a company in your portfolio), and an optional quick reference to the unique identifier of company, if it has a “My Company” set.
Use GET: Portfolio Details to get information about the companies in your portfolio.
Example Request
curl https://api.bitsighttech.com/ratings/v1/companies -u api_token:
Example Response
{ "my_company": { "guid": "b940aa61-42c9-33c4-9233-d8194c305db3" }, "companies": [ { "guid": "8c87c257-6767-42ad-8369-c4c5833851d4", "custom_id": "abc-123", "name": "Teacup Demolition Corp.", "shortname": "TDCorp", "network_size_v4": 0, "rating": 710, "rating_date": "2020-02-04", "date_added": "2014-11-03", "industry": "Engineering", "industry_slug": "engineering", "sub_industry": "Construction", "sub_industry_slug": "construction", "type": "CURATED", "logo": "https://api.bitsighttech.com/ratings/v1/companies/8c87c257-6767-42ad-8369-c4c5833851d4/logo-image", "sparkline": "https://api.bitsighttech.com/ratings/v1/companies/8c87c257-6767-42ad-8369-c4c5833851d4/sparkline?size=small", "external_id": 1710001246, "subscription_type": "Total Risk Monitoring", "subscription_type_key": "continuous_monitoring", "primary_domain": "teacupdemo.com", "security_grade": null, "grade_date": null, "display_url": "https://service.bitsighttech.com/app/company/companies/8c87c257-6767-42ad-8369-c4c5833851d4/overview", "href": "https://api.bitsighttech.com/ratings/v1/companies/de33c445-7619-4935-b1d6-e6c5b9a6b834" } ], "rating_date": "2014-11-10", "created": "2012-10-31" }
Response Attributes
Field | Description | |
---|---|---|
my_companyObject |
Details of your company. | |
guidString [ entity_guid ] |
Your organization's company unique identifier. If your organization has not purchased monitoring for its own company, this field and the my_company object will not be returned by the API server. |
|
companiesArray |
Details of companies within your portfolio of no particular order. | |
guidString [ entity_guid ] |
The unique identifier of this company. | |
custom_idString |
The customizable ID assigned to this company. | |
nameString |
The name of this company. | |
shortnameString |
The abbreviated name of this company. | |
network_size_v4Integer |
The number of IPv4 addresses attributed to this company. | |
ratingInteger |
The most recent security rating of this company. | |
rating_dateString [ YYYY‑MM‑DD ] |
The date when the rating report for this company was generated. | |
date_addedString [ YYYY‑MM‑DD ] |
The date when this company was added to your portfolio. | |
industryString |
The industry of this company. | |
industry_slugString |
The slug name of this company's industry. | |
industry_slugString |
The sub-industry of this company. | |
sub_industry_slugString |
The slug name of this company's sub-industry. | |
typeString |
The rating type. | |
logoString |
The URL in the Bitsight platform to this company's logo image. | |
sparklineString |
The URL in the Bitsight platform to this company's historical ratings trend line. | |
external_idInteger |
For internal Bitsight use. | |
subscription_typeString |
The subscription type used to monitor this company. | |
subscription_type_keyString |
The slug name of the subscription type used to monitor this company. | |
primary_domainString |
The primary domain of this company. | |
security_gradeNull |
For internal Bitsight use. | |
grade_dateNull |
For internal Bitsight use. | |
display_urlString |
The URL in the Bitsight platform to this company's overview page. | |
hrefString |
The URL in the Bitsight platform to this company's page. | |
rating_dateString [ YYYY‑MM‑DD ] |
The most recent date when security ratings were available. | |
createdString [ YYYY‑MM‑DD ] |
The date when your Bitsight account was established. |