Skip to content
PrefactorPrefactorPrefactor Docs

List alerts

GET
/api/v1/alerts
curl --request GET \
  --url https://app.prefactorai.com/api/v1/alerts \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
agent_instance_id
One of:
AgentInstance_Id

A valid agent instance ID

string
Example
013xrzp12g3nqk8ns6jadrqmpgrjkeny
agent_id
One of:
Agent_Id

A valid agent ID

string
Example
013xrzp12g3nqk8ns6jadrqmpgrjkeny
environment_id
One of:
Environment_Id

A valid environment ID

string
Example
013xrzp12g3nqk8ns6jadrqmpgrjkeny
status
One of:
string
Allowed values: raised cleared
Example
raised
severity
One of:
string
Allowed values: critical error warning info
Example
warning
name
One of:
string
Example
high_error_rate
active_during[start_at]
One of:
string format: date-time
Example
2024-01-01T00:00:00Z
active_during[finish_at]
One of:
string format: date-time
Example
2024-01-01T00:00:00Z
idempotency_key
One of:

Optional idempotency key for ensuring request idempotency

string
sorting

Sort order; a field name, optionally prefixed with - for descending (e.g. -id). Supported fields: id, raised_at, cleared_at, name, severity. Descending severity puts critical first because severity is stored as a magnitude. When omitted, the default order is raised first, then severity descending, then cleared_at descending, then name ascending.

string

Sort order; a field name, optionally prefixed with - for descending (e.g. -id). Supported fields: id, raised_at, cleared_at, name, severity. Descending severity puts critical first because severity is stored as a magnitude. When omitted, the default order is raised first, then severity descending, then cleared_at descending, then name ascending.

pagination[offset]
integer

Zero-based offset of the first item to return.

pagination[page_size]
integer
>= 1 <= 100

Number of items to return per page (1-100).

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
pagination
One of:
PaginationOutput

Pagination information

object
item_count

The total number of items

integer
item_end

The index of the last item in the page (one-based)

integer
item_start

The index of the first item in the page (one-based)

integer
next_page_offset
One of:

The offset of the next page (null if last page)

integer
page_count

The total number of pages

integer
page_index

The index of the current page (one-based)

integer
page_offset

The offset of the first item in the page (zero-based)

integer
page_size

The number of items per page

integer
previous_page_offset
One of:

The offset of the previous page (null if first page)

integer
sorting
One of:
Sorting

Sorting information

object
direction

The direction to sort by

string
Allowed values: asc desc
field

The field to sort by (values depend on the type of list)

string
Allowed values: id status started_at finished_at email name external_identifier raised_at cleared_at severity last_activity_span_at
nulls

Where to place null values. auto leaves placement to the database default.

string
Allowed values: first last auto
status
string
Allowed values: success
summaries
Array<object>
Alert_Summary
object
account_id
Account_Id

A valid account ID

string
agent_id
Agent_Id

A valid agent ID

string
agent_instance_id
AgentInstance_Id

A valid agent instance ID

string
cleared_at
One of:

When the alert was cleared (null while raised)

string format: date-time
environment_id
Environment_Id

A valid environment ID

string
id
Alert_Id

A valid alert ID

string
inserted_at

When the alert row was created

string format: date-time
name

Name of the alert (key in the agent schema version alert_schemas)

string
raised_at

When the alert was raised

string format: date-time
severity

Severity of the alert

string
Allowed values: critical error warning info
status

Lifecycle status of the alert: ‘raised’ or ‘cleared’

string
Allowed values: raised cleared
summary
One of:

Short display text for the alert, rendered from the alert schema template (null when the schema has no template).

string
title

Human-readable title from the alert schema (defaults to name when the schema has no title)

string
type

Type of resource (always ‘alert’)

string
Allowed values: alert
updated_at

When the alert row was last updated

string format: date-time
version

Monotonic version of this alert row. Starts at 1 and increments on each real update.

integer
>= 1
Example
{
  "pagination": {
    "item_count": 200,
    "item_end": 100,
    "item_start": 91,
    "next_page_offset": 110,
    "page_count": 20,
    "page_index": 10,
    "page_offset": 90,
    "page_size": 10,
    "previous_page_offset": 80
  },
  "sorting": null,
  "status": "success",
  "summaries": [
    {
      "account_id": "013xrzp12g3nqk8ns6jadrqmpgrjkeny",
      "agent_id": "013xrzp12g3nqk8ns6jadrqmpgrjkeny",
      "agent_instance_id": "013xrzp12g3nqk8ns6jadrqmpgrjkeny",
      "cleared_at": "2024-01-01T00:00:00Z",
      "environment_id": "013xrzp12g3nqk8ns6jadrqmpgrjkeny",
      "id": "013xrzp12g3nqk8ns6jadrqmpgrjkeny",
      "inserted_at": "2024-01-01T00:00:00Z",
      "name": "high_error_rate",
      "raised_at": "2024-01-01T00:00:00Z",
      "severity": "critical",
      "status": "raised",
      "summary": "Error rate exceeded threshold",
      "title": "High error rate",
      "type": "alert",
      "updated_at": "2024-01-01T00:00:00Z",
      "version": 1
    }
  ]
}

default

Section titled “default”

Error

Media typeapplication/json
One of:
object
code
string
Allowed values: bad_request bad_authtoken not_authenticated not_permitted not_implemented unknown not_found unexpected_ref_type unexpected invalid_action alert_unknown alert_already_cleared invalid_value required_value idempotency_key_already_used
message
string
status
string
Allowed values: error
Example
{
  "code": "bad_request",
  "status": "error"
}