GET: Enterprise Analytics

Ingrid

https://api.bitsighttech.com/ratings/v1/subsidiaries/company_guid/recommendations

Get recommendations for improving your subsidiaries through Enterprise Analytics.

Parameters

* Required.

company_guid

* Required.

[Query] Identify your My Company or My Subsidiary for using Enterprise Analytics.

Value: [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
company Object				Your My Company.
	guid String [`entity_guid`]			Your My Company’s unique identifier.
	name String			Your My Company’s name.
	subscription_type_key String			The subscription slug name used for your My Company.
guid String [`entity_guid`]				For internal Bitsight use.
last_computed String [`YYYY-MM-DDTHH:MM:SS`]				The date and time of the analysis.
owner Null				For internal Bitsight use.
status String				For internal Bitsight use.
steps Array				Rating improvement steps.
	Object			A step.
		company Object		Your My Company or subsidiary associated with this step. The details are empty or null if you are not subscribed to this company.
			guid String [`entity_guid`]	This company’s unique identifier.
			name String	This company’s name.
			subscription_type_key String	The subscription slug name used for this company.
		rating_after Integer		The parent’s rating if the findings from this step were remediated.
		rating_before Integer		The parent’s rating at the start of this step.
		risk_vector String		The risk vector associated with this step.
		step Integer		The step’s sorting order.

Status Codes

See the common errors and status codes.

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.

June 24, 2022: Published.