GET: Percent Change Alert Details – Bitsight Knowledge Base

https://api.bitsighttech.com/ratings/v1/alerts/percent/alert_guid

See details of Percent Change alerts. The Percent Change alert category allows you to filter and get alerts when security ratings decrease or increase by a set percentage. This is useful for monitoring general fluctuations in a company or country's cyber security posture.

Parameters

See all available parameters.

* Required.

guid

* Required.

[Path] Identify a Percent Change [PERCENT_CHANGE] alert to query.

Value:[String] Alert unique identifier [alert_guid]. See GET: Alerts.

Example Request

curl https://api.bitsighttech.com/ratings/v1/alerts/percent/1234567890 -u api_token:

Example Response

{
  "guid": 1234567890,
  "alert_date": "2015-02-01",
  "company_name": "Saperix, Inc.",
  "company_guid": "b940aa61-42c9-33c4-9233-d8194c305db3",
  "start_date": "2017-01-30",
  "start_rating": 710,
  "end_rating": 650,
  "folder_guid": "cb7ea5c9-e58f-4f85-a45c-6642c11d07ea",
  "company_url": "/company/15379",
  "rating_change_pct": -5,
  "alert_severity": "WARN",
  "alert_type": "PERCENT_CHANGE"
}

Response Attributes

Field Description

guid

Integer [alert_guid]

The unique identifier of the alert.

alert_date

String [YYYY‑MM‑DD]

The date when the alert was generated.

company_name

String

The name of the company that triggered the alert.

company_guid

String [entity_guid]

The unique identifier of the company associated with this alert.

Portfolio Quality Alerts: This value is none.

info_category

String

The corresponding risk category for this alert, e.g., Exposed Credentials.

Informational alerts only.

message

String

Additional details about this alert.

Informational alerts only.

start_date

String [YYYY‑MM‑DD]

The date when the rating was observed before the change.

start_rating

Integer

The company’s security rating during the start date.

Percent Change and Threshold alerts only.

end_rating

Integer

The company’s security rating when the alert was generated.

Percent Change and Threshold alerts only.

folder_guid

String [folder_guid]

The unique identifier of the folder where the alert was created. This may be your “All Companies” folder if the company was not in a specific folder.

company_url

String

Append this to “bitsight.com” to visit the company’s security rating overview page directly.

rating_change_pct

Integer

A positive or negative number indicating the percentage change in rating, from the start date to the end date.

Percent Change alerts only.

alert_severity

String

The level of change that generated this alert. See change severity.

rating_threshold

String

The rating that the alert setting threshold was set to.

Rating Threshold alerts only.

risk_category

String

The corresponding risk type for this alert. See risk types.

Risk Vector Grade alerts only.

start_grade

Integer

The starting grade for the alert.

Risk Vector and NIST CSF (grade change) alerts only.

end_grade

Integer

The ending grade for the alert.

Risk Vector and NIST CSF (grade change) alerts only.

nist_category

String

The corresponding NIST CSF category code for this alert, e.g., PR.PT.

NIST CSF alerts only.

nist_category_name

String

The human-readable subcategory name, e.g., Proactive Technology.

NIST CSF alerts only.

grade_threshold

String

The letter grade threshold that was crossed when the alert was generated.

NIST CSF alerts only.

alert_type

String

The condition that triggered the alert. See alert categories.

August 26, 2022: Specified PERCENT_CHANGE alerts only.
March 11, 2020: Published.

Parameters

Example Request

Example Response

Response Attributes

Related articles