GET: Assessment Report Data

Ingrid

https://api.bitsighttech.com/ratings/v1/assessment/assessments/templates/template_guid/companies/company_guid

Get the results and details of your organization’s assessments.

Parameters

* Required.

company_guid

* Required.

[Path] Identify the company to query.

Value: [String] Company unique identifier [entity_guid]. See GET: Portfolio Details.

template_guid

* Required.

[Path] Identify the template to use for the assessment report.

Value: [String] Template unique identifier [template_guid]. See GET: Assessment Report Template.

Example Request

curl 'https://api.bitsighttech.com/ratings/v1/assessment/assessments/templates/template_guid/companies/company_guid' -u api_token:

Example Response

{
  "questions": [
    {
      "content": "Is there a documented policy for what data is encrypted during transit?",
      "context": "We support this control with evidence of SSL encryption and certificates enforced; SSL configuration showing validation of correct encryption standards or failing and weak protocols.",
      "flag": true,
      "id": "DP.004",
      "risk_type_grades": [
        {
          "grade": "A",
          "name": "SSL Certificates"
        },
        {
          "grade": "D",
          "name": "SSL Configurations"
        }
      ],
      "section": "Security",
      "sub_section": "Data Protection"
    }
  ]
}

Response Attributes

Field			Description
questions Array			The assessment questions and their details.
	content String		The stated assessment question.
	context String		Associates the assessment question with the data behind the Bitsight risk vector.
	flag Boolean		`true` = This question has been identified as important or of high priority.
	id String		The unique identifier of this question.
	risk_type_grades Array		Indicates how this company is performing in the associated risk type.
		grade String	The letter grade of this risk vector.
		name String	The name of the risk vector. See risk types.
	section String		The section of the assessment that this question is categorized into.
	sub_section String		The sub-section of the assessment that this question is categorized into.

March 16, 2020: Published.