GET: Alerts

Ingrid

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

See your existing alerts and their details.

Parameters

See query parameters for details on the following parameters:

limit (Default: ↻ 100)
offset
q – Company names.
sort (Default: ↻ alert_date)
- guid – Alert unique identifier [alert_guid].
- alert_date
- alert_type
- company_name
- folder_name
- trigger
- severity

alert_date

[Query] Filter alerts by the specified alert date.

Value: [String] YYYY‑MM‑DD

alert_date_gt

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

Value: [String] YYYY‑MM‑DD

alert_date_gte

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

Value: [String] YYYY‑MM‑DD

alert_date_lt

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

Value: [String] YYYY‑MM‑DD

alert_date_lte

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

Value: [String] YYYY‑MM‑DD

alert_type

[Query] Filter alerts by the specified alert category.

Value: [String] Alert category.

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] company_custom_id, 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] Change severity.

Example Request

curl https://api.bitsighttech.com/ratings/v2/alerts -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			Contains navigation links for pagination.
	previous String [`URL`]		The link for navigating to the previous page of the results.
	next String [`URL`]		The link for navigating to the next page of the results.
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 conditions 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_guid String [`entity_guid`]	The unique identifier of the company that this alert was generated for.
		company_custom_id String	A customer-provided custom ID for the organization.
		company_url String [`URL`]	The link 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 is 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.

Comments

0 comments

Please sign in to leave a comment.