Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update review APIs docs #11457

Merged
merged 1 commit into from
May 20, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 38 additions & 6 deletions docs/docs/integrations/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -464,21 +464,53 @@ Summary of reviews for the last 30 days. Accepts the following query string para
| `labels` | str | , separated list of labels |
| `timezone` | str | Timezone name |

### `POST /api/review/<id>/viewed`
### `POST /api/reviews/viewed`

Mark an item as reviewed.
Mark item(s) as reviewed.

**Required Body:**

```json
{
"ids": ["123", "456"] // , separated list of review IDs
}
```

### `DELETE /api/review/<id>/viewed`

Mark an item as not reviewed.

### `POST /api/reviews/<ids>/viewed`
### `POST /api/reviews/delete`

Delete review items.

**Required Body:**

```json
{
"ids": ["123", "456"] // , separated list of review IDs
}
```

### `GET /review/activity/motion`

Get the motion activity for camera(s) during a specified time period.

Mark multiple items as reviewed. IDs are passed in as a comma separated list.
| param | Type | Description |
| ---------- | ---- | -------------------------------------------------------------- |
| `before` | int | Epoch time |
| `after` | int | Epoch time |
| `cameras` | str | , separated list of cameras |

### `DELETE /api/reviews/<ids>`
### `GET /review/activity/audio`

Delete items. IDs are passed in as a comma separated list
Get the audio activity for camera(s) during a specified time period.

| param | Type | Description |
| ---------- | ---- | -------------------------------------------------------------- |
| `before` | int | Epoch time |
| `after` | int | Epoch time |
| `cameras` | str | , separated list of cameras |

## Timeline

Expand Down
Loading