Publication Date – February 26, 2020
https://api.bitsighttech.com/ratings/v1/reports
Get a single company’s Bitsight Security Rating Report (PDF). The report includes the information presented in the company details and rating details, statistics information, and remediation instructions for Compromised Systems events.
There are currently no configuration options.
Parameters
*Required.
Parameter | Description | Values | |
---|---|---|---|
paramsBody |
Company details. | [Object] | |
companyBody |
Identify the company to query. | [String] Company unique identifier [entity_guid ]. See GET: Portfolio Details. |
Example Request
cURL:
curl -X POST https://api.bitsighttech.com/ratings/v1/reports -u api_token: -H "Content-Type: application/json" -d '{"params":{"company":"a940bb61-33c4-42c9-9231-c8194c305db3"}}' --output filename.pdf
JSON:
{ "params":{ "company":"a940bb61-33c4-42c9-9231-c8194c305db3" } }
Example Response
If successful, you will get a “PDF request queued” message and will be notified via email when the report is ready. Go to the Notifications page from the top-right of the Bitsight platform and then filter by the Report notification type to download the PDF.