Skip to main content

Detections

Query a person's (or a face's) detection history — the times that face was seen by a detector, with the confidence, detector name, and the detection photo.

API Endpoints

  • Base URL (Cloud): https://customername.econnectcloud.com/identities
  • Base URL (On-prem): https://<server-host-or-ip>:5009
MethodEndpointDescription
GET/api/v1/people/detections/personId/{personId}Detections for a person.
GET/api/v1/people/detections/faceId/{faceId}Detections for a specific face.

Authentication

Requires a JWT bearer token. See Authentication.

Minimum Permission

The permission name and category below are what you'll see in the Identities web app under System → System settings → Roles.

PermissionCategory
Read DetectionsIdentities

Query Parameters

ParameterTypeDefaultDescription
skipint0Number of records to skip (paging).
takeint10Maximum records to return.
epochStartMsintLower time bound, Unix epoch milliseconds.
epochEndMsintUpper time bound, Unix epoch milliseconds.
dateAscendingbooltrueSort oldest-first (true) or newest-first (false).

Code Examples

API_URL="https://customername.econnectcloud.com/identities"
TOKEN="your_jwt"

# Most recent 10 detections for a person
curl -sk -X GET "$API_URL/api/v1/people/detections/personId/0a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d?take=10&dateAscending=false" \
-H "Authorization: Bearer $TOKEN" | jq

# Detections for a specific face
curl -sk -X GET "$API_URL/api/v1/people/detections/faceId/5f9c2b7a-3e41-4d8a-9b6c-1a2b3c4d5e6f?skip=0&take=25" \
-H "Authorization: Bearer $TOKEN" | jq

Response

200 OK — an array of detection items:

[
{
"confidence": 0.972,
"dateTimeUtc": "2026-06-16T18:32:05Z",
"timeZone": "America/Los_Angeles",
"detector": "FrontDoorCam",
"image": "base64_jpeg_or_null"
}
]

Response Fields

FieldTypeDescription
confidencefloatMatch confidence for the detection.
dateTimeUtcstring (ISO-8601 UTC)When the detection occurred.
timeZonestringIANA time zone recorded for the detection.
detectorstringName of the detector/source (N/A if unknown).
imagestring (base64)The detection photo, or null if unavailable.

Response Codes

CodeMeaning
200 OKQuery ran; returns the detections (possibly empty).
401 UnauthorizedMissing or invalid JWT.
403 ForbiddenThe user lacks the Read Detections permission.