list_recognition_detections
Get all individual sightings for a recognition group on a Protect console. Specify group_id and type to retrieve detections with timestamps, cameras, and confidence scores.
Instructions
List a recognition group's detections (individual sightings) on a Protect console.
REQUIRED: both type and group_id. group_id identifies which enrolled subject to
list sightings for — obtain a valid one from list_recognition_groups (its id field,
e.g. face_90); there is no "all groups" mode. Calling without group_id fails schema
validation, and passing an id that does not exist on the console returns HTTP 404.
Each detection carries id, eventId (joinable against list_protect_events), thumbnailId (fetch the crop with get_thumbnail), detectedAt (epoch ms), cameraId, and matchedGroupConfidence (0-100).
Response shape: {"detections": [...], "count": N} (plus "nextPage" / "incomplete" when paging manually). The array key is "detections", NOT "data" — unlike the offset-proxy tools that return {"data": [...], "totalCount": N}; read the list from result["detections"].
host: console name, ID, or composite ID (MAC:numericId format).
type: recognition type. Use 'face' or 'vehicle' (singular -- plural forms
return HTTP 400 from upstream). Forwarded to the API as-is.
group_id: REQUIRED. The group's stable id, e.g. face_90 — take it from a
list_recognition_groups result (the id field). Not optional; not guessable.
page_size: API page size; also the drain page size. Defaults to 200.
start/end: optional time window in epoch SECONDS (UTC), converted to milliseconds
internally. Verified live: the endpoint filters detections server-side by detectedAt
against this window, so an arbitrary range (e.g. the last hour, 30 days, or 90 days)
can be requested directly. Omit both for all detections.
page: fetch a single page (1-based) instead of draining. The response pages via a
links.next envelope; by default every page is drained so the complete detection set
for the group (and window, if given) is returned. Pass page to fetch one page
manually — nextPage is then surfaced.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| end | No | ||
| host | Yes | ||
| page | No | ||
| type | Yes | ||
| start | No | ||
| group_id | Yes | ||
| page_size | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||