GET, POST: Preview Report with Industry Comparison – Bitsight Knowledge Base

https://api.bitsighttech.com/ratings/v1/companies/company_guid/reports/company-preview

This provides a synopsis of how a company is performing when compared to its industry peers.

It includes the company’s security rating on the first day of this quarter and the company’s security rating on the first day of the previous quarter.
It also provides a comparison of the risk vectors by industry.

This report is currently available in JSON through the Bitsight API. To retrieve a Preview Report, the company must first be in your portfolio. You can subscribe to the company using the subscriptions endpoint.

Run the following GET request with the unique identifier (GUID) of the company for which you’d like to run the report and your API token:

Example GET (HTML) Request

curl https://api.bitsighttech.com/ratings/v1/companies/eed24cfa-c3ea-4467-aefa-89648881e277/reports/company-preview?format=html -u api_token:

Example GET (HTML) Response

Save the Hypertext Markup Language (HTML) text, including the style.

Example POST (JSON) Request

Run the following POST request with the unique identifier (GUID) of the company for which you’d like to run the report and your API token:

curl -H 'Content-Type: application/json' -X POST https://api.bitsighttech.com/ratings/v1/companies/eed24cfa-c3ea-4467-aefa-89648881e277/reports/company-preview -d '{"format": "json"}' -u api_token:

Example POST (JSON) Response

{
  "company":{
    "company_guid":"eed24cfa-c3ea-4467-aefa-89648881e277",
    "report_date":"July 9, 2019",
    "name":"Saperix Corporate",
    "url":"http://saperix.com/corporate",
    "industry":"Technology",
    "ratings":[
      {
        "rating_date":"2019-07-01",
        "rating":720,
        "range":"Intermediate",
        "rating_color":"#e8a951",
        "industry_percentile":90
      },
      […]
    ],
    "rating_details":[
      […]
      {
        "category":"Diligence",
        "name":"SPF",
        "industry_comparison":"Below Industry Average",
        "slug":"spf"
      }
    ]
  }
}

Response Attributes

The name field is subject to change. If you are mapping the rating_detail to another tool, please use the slug instead of the name key for mapping purposes.

Field			Description
company Object			Contains this organization’s report details.
	company_guid String [`entity_guid`]		The unique identifier of this organization.
	report_date String [`Month D, YYYY`]		The date when the request to this endpoint was made.
	name String		The display name of this organization.
	url String		This organization’s website URL.
	industry String		This organization’s industry.
	ratings Object		Returns two instances of ratings for comparison; one from the most recent quarter and one from the last quarter.
		rating_date String [`YYYY‑MM‑DD`]	The date from the first day of the quarter.
		rating Integer	This organization’s security rating during the posted date.
		range String	The rating category.
		rating_color String [`Hex Code`]	The hexadecimal color code used for displaying the color associated with the rating category.
		industry_percentile Integer	The percentile this organization is placed in, based on its rating within the industry.
	rating_details Object		Contains this organization’s rating details.
		category String	The risk category.
		name String	The display name of this risk vector.
		industry_comparison String	Compares this organization to its industry. Values: Above Industry Average Same as Industry Average Below Industry Average
		slug String	A fixed reference to the risk vector, used for mapping purposes.

July 9, 2019: Published.

Example GET (HTML) Request

Example GET (HTML) Response

Example POST (JSON) Request

Example POST (JSON) Response

Response Attributes

Related articles