Hanzo AI
OpenapiPatrol

List event

Lists the feed, newest first. It is the same rows the live stream carries, read back for a screen that has just opened — so the window is the newest rows,…

GET /v1/patrol/event

Addresshttps://api.hanzo.ai/v1/patrol/event
MethodGET
Operationget_patrol_event
AuthAuthorization: Bearer $HANZO_API_KEY

Lists the feed, newest first. It is the same rows the live stream carries, read back for a screen that has just opened — so the window is the newest rows, or a screen that reloads reads a feed that stopped on the day the tenant was installed.

Request

2 fields.

FieldInTypeRequiredDescription
levelquerystringLevel narrows the list to red, amber, green or cyan.
limitqueryintegerLimit caps how many rows are returned.

Response

StatusBodyMeaning
200patrol.patrolEventListok
defaultproblem-detailsrefused

200 body — 9 fields.

FieldInTypeAlwaysDescription
databodypatrol.patrolEvent[]Data is the matching rows, newest first.
data[].atbodystringAt is when it was raised.
data[].detailbodystringDetail is the longer account, or empty.
data[].levelbodystringLevel is red, amber, green or cyan.
data[].namebodystringName is the event's document name.
data[].sitebodystringSite is the site the event is about, or empty.
data[].sourcebodystringSource is what raised it.
data[].titlebodystringTitle is the one line the feed shows.
data[].unitbodystringUnit is the unit the event is about, or empty.

Failure carries the platform error shape — see Errors.

Examples

hanzo patrol event get

Patrol API · All Hanzo APIs · Interactive reference

How is this guide?

On this page