https://api.bitsighttech.com/ratings/v1/subsidiaries/company_guid/recommendations
Get recommendations for improving your subsidiaries through Enterprise Analytics.
Parameters
* Required.
Parameter | Values |
---|---|
company_guid * [Query] Identify your My Company or My Subsidiary for using Enterprise Analytics. |
[String] Company unique identifier [entity_guid ]. See GET: Portfolio Details. |
Example Request
curl https://api.bitsighttech.com/ratings/v1/subsidiaries/a940bb61-33c4-42c9-9231-c8194c305db3/recommendations -u api_token:
Example Response
{ "company": { "guid": "a940bb61-33c4-42c9-9231-c8194c305db3", "name": "Saperix, Inc.", "subscription_type_key": "continuous_monitoring" }, "guid": "c108ac2b-09e7-4c63-a81e-8f24ab8e67f6", "last_computed": "2022-06-21T16:10:28.619238+00:00", "owner": null, "status": "complete", "steps": [ […] { "company": { "guid": "a940bb61-33c4-42c9-9231-c8194c305db3", "name": "Saperix, Inc.", "subscription_type_key": "continuous_monitoring" }, "rating_after": 720, "rating_before": 700, "risk_vector": "application_security", "step": 3 }, […] ] }
Response Attributes
Field | Description | |||
---|---|---|---|---|
companyObject |
Your My Company. | |||
guidString [ entity_guid ] |
Your My Company’s unique identifier. | |||
nameString |
Your My Company’s name. | |||
subscription_type_keyString |
The subscription slug name used for your My Company. | |||
guidString [ entity_guid ] |
For internal Bitsight use. | |||
last_computedString [ YYYY-MM-DDTHH:MM:SS ] |
The date and time of the analysis. | |||
ownerNull |
For internal Bitsight use. | |||
statusString |
For internal Bitsight use. | |||
stepsArray |
Rating improvement steps. | |||
Object | A step. | |||
companyObject |
Your My Company or subsidiary associated with this step. The details are empty or null if you are not subscribed to this company. | |||
guidString [ entity_guid ] |
This company’s unique identifier. | |||
nameString |
This company’s name. | |||
subscription_type_keyString |
The subscription slug name used for this company. | |||
rating_afterInteger |
The parent’s rating if the findings from this step were remediated. | |||
rating_beforeInteger |
The parent’s rating at the start of this step. | |||
risk_vectorString |
The risk vector associated with this step. | |||
stepInteger |
The step’s sorting order. |
Status Codes
See the common errors and status codes.
Code | Description |
---|---|
200 – OK |
Everything worked as expected. |
401 – No Authentication |
No valid API token was provided. |
403 – Unauthorized |
You do not have permission to access this resource. |
404 – Not Found |
The specified resource could not be found or does not exist. |
500 – Server Error |
The server encountered an error. |
503 – Server Not Ready |
The server is not ready to handle a request. This may be due to the server being down for maintenance or it is overloaded. |
Publication Date – June 24, 2022
Feedback
0 comments
Please sign in to leave a comment.