alerts

List firearm alert events

Changed on

Returns the organization's firearm alert events raised in a time window, newest first. Both start_time and end_time are required and the window may span at most 7 days. Pagination uses the same page + limit + has_more shape as every other developer-API list endpoint.

Each result has the shape /alerts/{alert_event_id}/details returns, with the AI description and the clip. This list never starts a clip download. Where /details would request one, the clip here reads pending for 5 minutes after the alert and failed after that. The list leaves out alert events waiting for or failing AI verification.

get/v1/alerts/firearm/events

Request

  • Base URL
    https://developer.coram.ai
  • URL
    https://developer.coram.ai/v1/alerts/firearm/events
  • Auth
    API key in header X-Auth-Token

Query parameters

start_timestring date-time required

RFC3339 inclusive lower bound on alert_time.

end_timestring date-time required

RFC3339 inclusive upper bound on alert_time. Must not be before start_time or more than 7 days after it.

pageinteger

1-indexed page number.

limitinteger

Maximum alert events per page (capped at 100).

Response

Successful Response

has_moreboolean required

True if a further page beyond page exists.

Changes