Skip to main content
Security Performance Management
Continuous Monitoring
Vendor Risk Management
Trust Management Hub
Cyber Insurance
National Cybersecurity

GET: Alerts [v1]

Ingrid

⇤ Alerts

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

Get a list of your existing alerts and their details.

Version 2 is now available.

Parameters

See query parameters for details on the following parameters:

  • limit (Default: ↻ 100)
  • offset
  • q
  • sort
    • guid
    • ↻ alert_date (Default)
    • alert_type
    • company_name
    • folder_name
    • trigger
    • severity
Parameter Values 
alert_date

[Query] Filter alerts by the specified alert date.

 [String] YYYY-MM-DD 
alert_date_gt

[Query] Filter alerts after the requested date. This parameter is incompatible with alert_date.

 [String] YYYY-MM-DD 
alert_date_gte

[Query] Filter alerts after or on the requested date. This parameter is incompatible with alert_date.

 [String] YYYY-MM-DD 
alert_date_lt

[Query] Filter alerts prior to the requested date. This parameter is incompatible with alert_date.

 [String] YYYY-MM-DD 
alert_date_lte

[Query] Filter alerts prior to or on the requested date. This parameter is incompatible with alert_date.

 [String] YYYY-MM-DD 
alert_type

[Query] Filter alerts by a specified alert category.

 [String] Alert category. 
company_guid

[Query] Filter alerts by a specified company.

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

[Query] Include additional alert details.

 [String] details 
folder_guid

[Query] Filter alerts by a specified folder.

 [String] Folder unique identifier [folder_guid]. See GET: Folder Details. 
severity

[Query] Filter alerts by the specified severity level.

 [String] Alert severity slug name. See alert severity.

Example Request

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

Example Response

The entire response is an array, consisting of alert objects.

[
  {
    "alert_type": "PERCENT_CHANGE",
    "company_guid": "b940aa61-42c9-33c4-9233-d8194c305db3",
    "href": "https://api.bitsighttech.com/ratings/v1/alerts/percent/1029",
    "company_name": "Saperix, Inc.",
    "alert_date": "2017-02-18",
    "guid": 1029,
    "folder_guid": "cb7ea5c9-e58f-4f85-a45c-6642c11d07ea"
  }
  […]
]

Response Attributes

Field Description 
alert_type
String		 The type of condition that triggered the alert. See alert categories. 
company_guid
String [entity_guid]		 The unique identifier of the company that this alert was generated for.
Portfolio Quality Alerts: This value will be “none.”
 
href
String		 URI of the alert API resource, which contains additional details about the alert. Make an API call directly to this URI to return detailed information about the alert. 
company_name
String		 The name of the company that triggered the alert.
Portfolio Quality Alerts: This value is none.
 
alert_date
String [YYYY‑MM‑DD]		 The date when the alert was generated. 
guid
Integer [alert_guid]		 The unique identifier of the alert. 
folder_guid
String [folder_guid]		 The unique identifier of the folder for which the alert was created. This may be your “All Companies” folder if the company was not in a specific folder.
  • July 24, 2019: Version 2 is now available.

Related articles

Feedback

0 comments

Please sign in to leave a comment.