Docs updates (#12607)

This commit is contained in:
Nicolas Mowen
2024-07-25 07:14:22 -06:00
committed by GitHub
parent 51a1526146
commit cea0596cf5
3 changed files with 19 additions and 40 deletions

View File

@@ -381,9 +381,13 @@ List of frames in the preview cache for the time range. Previews are only kept i
Specific preview frame from preview cache.
### `GET /<camera>/start/<start-timestamp>/end/<end-timestamp>/preview.gif`
### `GET /<camera>/start/<start-timestamp>/end/<end-timestamp>/preview`
Gif made from preview video / frames during this time range
Looping image made from preview video / frames during this time range.
| param | Type | Description |
| --------- | ---- | -------------------------------- |
| `format` | str | Format of preview [`gif`, `mp4`] |
## Recordings
@@ -455,6 +459,10 @@ Reviews from the database. Accepts the following query string parameters:
| `limit` | int | Limit the number of events returned |
| `severity` | str | Limit items to severity (alert, detection, significant_motion) |
### `GET /api/review/<id>`
Get review with `id` from the database.
### `GET /api/review/summary`
Summary of reviews for the last 30 days. Accepts the following query string parameters:

View File

@@ -138,13 +138,14 @@ Message published for each changed review item. The first message is published w
"person",
"car"
],
"sub_labels": [],
"sub_labels": ["Bob"],
"zones": [
"front_yard"
],
"audio": []
}
}
}
```
### `frigate/stats`