Returns a list of alert events scoped to the authorization token.

SecurityAuthToken
Request
query Parameters
page
integer

indicates what page of a list of query results you want to view

page-size
integer

indicates the how many items to return per page in a list request

ordering
string

determines which column to sort by. Prepend with '-' to sort desc

shipment_id
string <uuid>

The id of the shipment

alert_level
string

The alert level

resource_id
string <uuid>

The resource_id

resource_type
string

The resource_type

secondary_resource_id
string <uuid>

The secondary_resource_id

secondary_resource_type
string

The secondary_resource_type

configuration_id
string <uuid>

The configuration id

assigned_to
string <uuid>

The assigned_to user id

assigned_to__isnull
boolean

Filter unassigned

resolved_by
string <uuid>

The resolved_by user id

resolved_by__isnull
boolean

Filter unresolved by user

resolved_at
string <date-time>

The resolved_at date-time

resolved_at__isnull
boolean

Filter unresolved

resolved_at__gte
string <date>

Filter resolved on or after a certain date and time

resolved_at__lte
string <date>

Filter resolved on or before a certain date and time

snoozed_until
string <date-time>

The snoozed_until date-time

snoozed_until__isnull
boolean

Filter not snoozed

snoozed_until__gte
string <date>

Filter snoozed until on or after a certain date and time

snoozed_until__lte
string <date>

Filter snoozed until on or before a certain date and time

snoozed_by
string <uuid>

The snoozed_by user id

snoozed_by__isnull
boolean

Filter not snoozed by user

created_at
string <date-time>

The created_at date-time

created_at__gte
string <date>

Filter created on or after a certain date and time

created_at__lte
string <date>

Filter created on or before a certain date and time

Responses
200

Successfully returned a list of AlertEvents

Response Schema: application/json
page_size
integer
Array of objects (AlertEvent)
total_count
integer
total_pages
integer
default

Default error response

get/alert-events/
Request samples
Response samples
application/json
{
  • "page_size": 0,
  • "results": [
    ],
  • "total_count": 0,
  • "total_pages": 0
}
Copyright © Shipwell 2023. All right reserved.