https://api.bitsighttech.com/ratings/v1/threats/threat_guid/companies
Get companies affected by a threat (such as vulnerabilities).
Version 2 is now available.
Parameters
*Required.
❖ Applicable only for threat groups.
See query parameters for details on the following parameters:
-
format
(Default: ↻json
) -
limit
(Default: ↻25
) -
offset
(Default: ↻0
) q
Parameter | Values | |
---|---|---|
evidence_certainty [Query] Filter by evidence certainty. |
See evidence certainty. | |
expand [Query] Include additional information. |
[String]
|
|
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 Dates | [String] The date [YYYY-MM-DD ]. |
|
first_seen_date_gte [Query] Filter threats first seen on and after a particular date. |
||
first_seen_date_lte [Query] Filter threats first seen on and before a particular date. |
||
last_seen_date_gte [Query] Filter threats last seen on and after a particular date. |
||
last_seen_date_lte [Query] Filter threats last seen on and before a particular date. |
||
sort [Query] Sort the response objects in alphabetical order. |
[String]
|
|
sub_threats_count_gte ❖ [Query] |
[Integer] Minimum: 0
|
|
sub_threats_count_lte ❖ [Query] |
[Integer] Minimum: 0
|
|
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/v1/threats/threat_guid/companies -u api_token:
Example Response
{ "links": { "previous": "string", "next": "string" }, "summaries": { "currently_count": 0, "previously_count": 0, "total_count": 0, "entity_group_size": 0, "sub_threats_count": 0 }, "count": 0, "results": [ { "company_name": "string", "evidence_certainty": "string", "exposure_detection": "string", "first_seen_date": "string", "last_seen_date": "string", "company_guid": "string", "tier": "string", "tier_name": "string", "logo": "string", "workflow_status": "string", "sub_threats_count": 0, "detection_types": [ "early_detection" ] } ] }
Response Attributes
Field | Description | ||
---|---|---|---|
linksObject |
Navigation for multiple pages of results. See pagination. | ||
previousString |
The URL for navigating to the previous page of results. | ||
next String |
The URL for navigating to the next page of results. | ||
summaries Object |
Exposure statistics. | ||
currently_count Integer |
|||
previously_countInteger |
|||
total_countInteger |
|||
entity_group_sizeInteger |
|||
sub_threats_countInteger |
|||
countInteger |
The number of companies affected by the threat. | ||
resultsArray |
Companies affected by the threat and details. | ||
Object | A company. | ||
company_nameString |
The company name. | ||
evidence_certaintyString |
The evidence certainty, which measures the certainty of the detection status. | ||
exposure_detectionString |
The company's protection status from threats. | ||
first_seen_dateString [ YYYY-MM-DD ] |
The date when the threat was first seen. | ||
last_seen_dateString [ YYYY-MM-DD ] |
The date when the threat was last seen. | ||
company_guidString [ entity_guid ] |
The company’s unique identifier. | ||
tierString |
The tier the company is in. | ||
tier_nameString |
The tier name. | ||
logoString |
The URL where this company’s logo image file is stored in the Bitsight platform. | ||
workflow_statusString |
|||
sub_threats_countInteger |
|||
detection_typesArray |
How the data was collected.
|
Status Codes
Code | Description |
---|---|
200 – Success |
Everything worked as expected. |
422 – Validation Error |
There was a validation error. |
- October 17, 2024: Version 2 is now available.
- March 1, 2024: Published.
Feedback
0 comments
Please sign in to leave a comment.