GET: Latest Alerts

Ingrid

https://api.bitsighttech.com/ratings/v2/alerts/latest

Get alerts generated during the most recent daily platform update.

This endpoint only returns results if any new alerts were generated during the most recent daily platform update.

Parameters

See query parameters for details on the following parameters:

limit (Default: ↻ 100)
offset
q – Company names.
sort
- guid
- alert_type
- company_name
- folder_name
- trigger
- severity

alert_type

[Query] Filter alerts by the specified alert category.

Value: [String] See alert categories.

company_guid

[Query] Filter by company.

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

expand

[Query] Include additional alert details.

Value: [String] ?expand=company_custom_id, ?expand=details

folder_guid

[Query] Filter alerts by the specified folder.

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

severity

[Query] Filter alerts by the specified change severity.

Value: [String] See change severity.

Example Request

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

Example Response

{
  "links":{
    "previous":null,
    "next":"https://api.bitsighttech.com/ratings/v2/alerts/?limit=100&offset=100"
  },
  "count":12345,
  "results":[
    […]
    {
      "guid":12345678,
      "alert_type":"RISK_CATEGORY",
      "alert_date":"2019-07-10",
      "start_date":"2019-07-09",
      "company_name":"Example, Inc.",
      "company_custom_id": "123-test",
      "company_guid":"e8d8503e-beae-4d6a-add4-5666c5491881",
      "company_url":"/company/e8d8503e-beae-4d6a-add4-5666c5491881/",
      "folder_guid":"02fa3d99-dfe5-4695-a26a-fa0a6f1ff98b",
      "folder_name":"Continuously Monitored",
      "severity":"WARN",
      "trigger":"Insecure Systems"
    }
  ]
}

Response Attributes

Field			Description
links Object			Navigation links for multiple pages of results. See pagination.
	previous String		The URL path to navigate to the previous page.
	next String		The URL path to navigate to the next page.
count Integer			The total number of alerts across all the pages.
results Array			Alerts.
	Object		An alert.
		guid String [`alert_guid`]	The unique identifier of this alert.
		alert_type String	The the slug name of the type of condition that triggered the alert. See alert categories.
		alert_date String [`YYYY‑MM‑DD`]	The date when the alert is generated.
		start_date String [`YYYY‑MM‑DD`]	The start date of the alert period.
		company_name String	The name of the company that triggered the alert.
		company_custom_id String	A customer-provided custom ID for the organization.
		company_guid String [`entity_guid`]	The unique identifier of the company that this alert was generated for.
		company_url String	The URL path to this company’s Overview page in the Bitsight platform.
		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.
		folder_name String	The name of this folder.
		severity String	The level of change that generated this alert. See change severity.
		trigger String	The type of data that generated this alert.

December 2, 2024: Added company_custom_id.
March 11, 2020: Linked to the overview on Pagination.