https://api.bitsighttech.com/ratings/v2/threats/threat_guid/companies
Get companies affected by a threat (such as vulnerabilities).
Parameters
See query parameters for details on the following parameters:
* Required.
❖ Applicable only for threat groups.
-
format
(Default: ↻json
) -
limit
(Default: ↻25
) -
offset
(Default: ↻0
) q
-
sort
(Default: ↻last_seen_date
)Parameter Values evidence_certainty
[Query] Filter by evidence certainty.
[String] See evidence certainty. evidence_tags
[Query] Filter by evidence.
[String]
LONG_TIME_SINCE_LAST_DETECTION
MITIGATION_APPLIED
RELATIONSHIP_WITH_VULNERABLE_PROVIDER_INDICATED
VULNERABLE_SOFTWARE_OR_CONFIGURATION_IN_USE
VULNERABLE_SOFTWARE_VERSION_IN_USE
expand
[Query] Include additional information.
[String]
-
sub_threats_count
= Include sub-threat counts in summaries and results for each company. -
workflow_status
= Include questionnaire status details.
exposure_detection
[Query] Filter by exposure detection status.
[String] See exposure detection. folder
[Query] Filter by folder.
[String] Folder unique identifier [ folder_guid
]. See GET: Folder Details.Seen Date [String] YYYY-MM-DD
first_seen_date_gte
[Query] Filter threats first seen on and after a specific date.
first_seen_date_lte
[Query] Filter threats first seen on and before a specific date.
last_seen_date_gte
[Query] Filter threats last seen on and after a specific date.
last_seen_date_lte
[Query] Filter threats last seen on and before a specific date.
Sub-Threat Count [Integer] Minimum: 0
sub_threats_count_gte
❖ [Query] Filter by the number (>e;) of sub-threats.
sub_threats_count_lte
❖ [Query] Filter by the number (<e;) of sub-threats.
sub_threat_guid
❖ [Query] Filter by companies affected by the identified threat.
[String] Threat unique identifier [ threat_guid
]. See GET: Portfolio Threats.threat_guid
*[Path] Identify the threat to query.
[String] Threat unique identifier [ threat_guid
]. See GET: Portfolio Threats.tier
[Query] Filter by tier.
[String] Tier unique identifier [ tier_guid
]. See GET: Tiers.Example Request
curl https://api.bitsighttech.com/ratings/v2/threats/threat_guid/companies -u api_token:
Example Response
{ "links": { "previous": null, "next": "https://api.bitsighttech.com/ratings/v2/threats/db72416d-454a-4551-a03e-74c749048d46/companies?&limit=10&offset=10" }, "count": 2325, "summaries": { "exposed_count": 2325, "mitigated_count": 0, "total_count": 2325, "entity_group_size": 13146 }, "results": [ { "company_name": "Black Hills Technologies", "evidence_certainty": "POSSIBLE", "exposure_detection": "EXPOSED", "first_seen_date": "2023-10-27", "last_seen_date": "2023-10-27", "company_guid": "a5e23bf0-38d4-4cea-aa50-19ee75da481d", "tier": null, "tier_name": null, "logo": "https://api.bitsighttech.com/ratings/v1/companies/a5e23bf0-38d4-4cea-aa50-19ee75da481d/logo-image", "detection_types": [ "early_detection" ], "evidence_tags": [ { "name": "Software from vulnerable provider in use", "slug": "SOFTWARE_FROM_VULNERABLE_PROVIDER_IN_USE" } ] }, […] ] }
Response Attributes
Field Description links
Object
Navigation for multiple pages of results. See pagination. previous
String
The URL for navigating to the previous page of results. next
String
The URL for navigating to the next page of results. count
Integer
The number of companies affected by the threat. summaries
Object
Exposure statistics. exposed_count
Integer
The number of companies that have been observed to have evidence of exposure (exposure). mitigated_count
Integer
The number of companies that have evidence of active mitigation (mitigation). total_count
Integer
The number of threats for companies in your portfolio. entity_group_size
Integer
results
Array
Companies affected by the threat and details. Object A company. company_name
String
The company name. evidence_certainty
String
The evidence certainty, which measures the certainty of the detection status. exposure_detection
String
The company's exposure detection status from threats. first_seen_date
String [
YYYY-MM-DD
]The date when the threat was first seen. last_seen_date
String [
YYYY-MM-DD
]The date when the threat was last seen. company_guid
String [
entity_guid
]The company’s unique identifier. tier
String
The tier the company is in. tier_name
String
The tier name. logo
String
The URL where this company’s logo image file is stored in the Bitsight platform. detection_types
Array
How the data was collected.
-
early_detection
= The data was collected from manually loaded sources. -
standard
= The data was collected through standard methods.
evidence_tags
Array
The type of evidence seen for this record.
LONG_TIME_SINCE_LAST_DETECTION
MITIGATION_APPLIED
RELATIONSHIP_WITH_VULNERABLE_PROVIDER_INDICATED
VULNERABLE_SOFTWARE_OR_CONFIGURATION_IN_USE
VULNERABLE_SOFTWARE_VERSION_IN_USE
Object The evidence. name
String
The name of the evidence. slug
String
The slug name of the evidence. Response Codes
Code Description 200
– SuccessEverything worked as expected. 422
– Validation ErrorThere was a validation error. - October 17, 2024: Published.
Feedback
0 comments
Please sign in to leave a comment.