Get events

GET 
https://demo.frigate.video/api/events

Returns a list of events.

Request

Query Parameters

camera object
Default value: all
cameras object
Default value: all
label object
Default value: all
labels object
Default value: all
sub_label object
Default value: all
sub_labels object
Default value: all
zone object
Default value: all
zones object
Default value: all
limit object
Default value: 100
after object
before object
time_range object
Default value: 00:00,24:00
has_clip object
has_snapshot object
in_progress object
include_thumbnails object
Default value: 1
favorites object
min_score object
max_score object
min_speed object
max_speed object
recognized_license_plate object
Default value: all
is_submitted object
min_length object
max_length object
event_id object
sort object
timezone object
Default value: utc

Responses

200

Successful Response

application/json

Schema

Schema

• Array [
idId (string)required
labelLabel (string)required
sub_label objectrequired
anyOf
string
string
null
null
cameraCamera (string)required
start_timeStart Time (number)required
end_time objectrequired
anyOf
number
number
null
null
false_positive objectrequired
anyOf
boolean
boolean
null
null
zonesstring[]required
thumbnail objectrequired
anyOf
string
string
null
null
has_clipHas Clip (boolean)required
has_snapshotHas Snapshot (boolean)required
retain_indefinitelyRetain Indefinitely (boolean)required
plus_id objectrequired
anyOf
string
string
null
null
model_hash objectrequired
anyOf
string
string
null
null
detector_type objectrequired
anyOf
string
string
null
null
model_type objectrequired
anyOf
string
string
null
null
dataobjectrequired
• ]

Example (auto)

[
  {
    "id": "string",
    "label": "string",
    "sub_label": "string",
    "camera": "string",
    "start_time": 0,
    "end_time": 0,
    "false_positive": true,
    "zones": [
      "string"
    ],
    "thumbnail": "string",
    "has_clip": true,
    "has_snapshot": true,
    "retain_indefinitely": true,
    "plus_id": "string",
    "model_hash": "string",
    "detector_type": "string",
    "model_type": "string",
    "data": {}
  }
]

422

Validation Error

application/json

Schema

Schema

detail object[]
Array [
loc object[]required
Array [
anyOf
string
string
integer
integer
]
msgMessage (string)required
typeError Type (string)required
]

Example (auto)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

• python
• nodejs
• javascript
• curl
• rust

• HTTP.CLIENT
• REQUESTS

import http.client

conn = http.client.HTTPSConnection("demo.frigate.video")
payload = ''
headers = {
  'Accept': 'application/json'
}
conn.request("GET", "/api/events", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

Request Collapse all

Base URL

https://demo.frigate.video/api

Parameters

camera — query

cameras — query

label — query

labels — query

sub_label — query

sub_labels — query

zone — query

zones — query

limit — query

after — query

before — query

time_range — query

has_clip — query

has_snapshot — query

in_progress — query

include_thumbnails — query

favorites — query

min_score — query

max_score — query

min_speed — query

max_speed — query

recognized_license_plate — query

is_submitted — query

min_length — query

max_length — query

event_id — query

sort — query

timezone — query

ResponseClear

Click the Send API Request button above and see the response here!