https://api.bitsighttech.com/ratings/v1/insights
Retrieve the significant rating change data of a requested company. The information includes the initial and final rating of a company over a certain range of time, the reason behind the rating change, and the percentile change of the company’s rating.
Parameters
See query parameters for details on the format (value: json) parameter.
* Required.
company-
* Required.
[Query] Identify the company to query.
Value: [String] Company unique identifier [
entity_guid]. GET: Portfolio Details. - [Date]
start -
[Query] Select the date for when to begin looking for insights.
Value: [String]
YYYY-MM-DD - [Date]
end -
[Query] Select the date for when to stop looking for insights.
Value: [String]
YYYY-MM-DD score_delta_lt-
[Query] Filter by rating change explanations (RCE), as highlighted in the Security Ratings Changes chart so that the delta is lower than the specified value.
Value: [String]
-
0= Include rating changes of 10 points or less. - If not specified, the results are filtered by a delta lower than -10 points.
-
Example Request
curl https://api.bitsighttech.com/ratings/v1/insights?company=company_guid -u api_token:
Example Response
[
{
"date":"2018-10-09",
"guid":"88deb5fa-d371-4707-b9fb-ffc1878cc28a",
"start_score":790,
"end_score":770,
"reasons":[
{
"start_percentile":47.59024,
"risk_vector":"insecure_sys",
"evidence":[
{
"end_grade":"D",
"start_grade":"C"
}
],
"end_percentile":31.86136,
}
],
"type":"rating-change",
"entity":"a940bb61-33c4-42c9-9231-c8194c305db3"
}
]
Response Attributes
| Field | Description | ||
|---|---|---|---|
date String [ |
The date when this organization's security rating changed. | ||
guid String [ |
The unique identifier of the insight. | ||
start_score Integer |
This organization’s security rating at the beginning of the day. | ||
end_score Integer |
This organization’s security rating at the end of the day. | ||
reasons Object |
The data points that contributed to the change in this organization’s security rating. | ||
start_percentile Decimal |
The percentile that this organization was placed in, at the beginning of the day. This is based on its rating within the industry. | ||
risk_vector String |
The slug name of the risk vector type that contributed to the reason for the change. | ||
evidence Object |
The letter grade of the risk vector that contributed to the reason for the change, before and after the change. | ||
end_grade String |
The letter grade of the risk vector that contributed to the reason for the change, after the change. | ||
start_grade String |
The letter grade of the risk vector that contributed to the reason for the change, before the change. | ||
end_percentile Decimal |
The percentile that this organization was placed in at the end of the day. This is based on its rating within the industry. | ||
type String |
The type of reason for the rating change.
Value:
|
||
entity String [ |
The unique identifier of this company. | ||
- July 10, 2023: Removed PDF.
- April 18, 2019: Published.
Feedback
0 comments
Please sign in to leave a comment.