List Alert - BlinkOps Documentation

Retrieve a filtered list of alerts.

External DocumentationTo learn more, visit the Panther documentation.

Basic Parameters

Parameter	Description
Assignee	Filter alerts by the assignee by its ID.
Created After	The timeframe after which alerts were created. When omitted, defaults to 30 days ago.
Created Before	The timeframe before which alerts were created. When omitted, defaults to current time.
Cursor	A token used to specify a results page. This value can be obtained from the `endCursor` property from a previous response.
Detection ID	Filter alerts by the detection ID.
Limit	The maximum number of results to return in the response. Valid range is `1`-`50`.
Name	Filter alerts by name, entering a partial or full string.
Return All Pages	Automatically fetch all resources, page by page.
Severity	Filter alerts by the severity.
Sort Direction	The sort direction of the results.
Status	Filter alerts by the status.
Sub Type	Filter alerts by the sub-type of the alert.
Type	Filter alerts by the type of the alert.

Advanced Parameters

Parameter	Description
Log Source	A comma-separated list of log sources of alerts to filter the results by.
Log Type	A comma-separated list of log types to filter the results by.
Maximum events	Filter alerts by the maximum number of events in each retrieved alert.
Minimum events	Filter alerts by the minimum number of events in each retrieved alert.
Resource Type	A comma-separated list of resource types to filter the results by.

Example Output

{
	"next": "text",
	"results": [
		{
			"assignee": {
				"id": "user",
				"type": "text"
			},
			"context": null,
			"createdAt": "text",
			"deliveries": [
				{
					"dispatchedAt": "text",
					"label": "text",
					"message": "text",
					"outputId": "text",
					"statusCode": 1,
					"success": true
				}
			],
			"detection": {
				"id": "text",
				"type": "RULE"
			},
			"eventCount": 1,
			"firstEventOccurredAt": "text",
			"id": "text",
			"lastReceivedEventAt": "text",
			"runbook": "text",
			"severity": "CRITICAL",
			"status": "OPEN",
			"systemError": {
				"detection": {
					"id": "text",
					"type": "RULE"
				},
				"sourceId": "text",
				"sourceType": "text",
				"type": "text"
			},
			"title": "text",
			"type": "text",
			"updatedBy": {
				"id": "user",
				"type": "text"
			}
		}
	]
}