Skip to main content
POST
/
api
/
faceRecognition
/
faceEvent
/
findFaceEventsByOrg
Find face events by organization
curl --request POST \
  --url https://api2.rhombussystems.com/api/faceRecognition/faceEvent/findFaceEventsByOrg \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "pageRequest": {
    "lastEvaluatedKey": "<string>",
    "maxPageSize": 123
  },
  "searchFilter": {
    "deviceUuids": [
      "AAAAAAAAAAAAAAAAAAAAAA.v0"
    ],
    "faceNameContains": "<string>",
    "faceNames": [
      "<string>"
    ],
    "hasEmbedding": true,
    "hasName": true,
    "labels": [
      "<string>"
    ],
    "locationUuids": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "personUuids": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "timestampFilter": {
      "rangeEnd": "2023-11-07T05:31:56Z",
      "rangeStart": "2023-11-07T05:31:56Z"
    }
  }
}
'
{
  "faceEvents": [
    {
      "detectionConfidence": 0.98,
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
      "embeddingConfidence": 0.95,
      "eventTimestamp": 1640995200000,
      "faceName": "<string>",
      "hasEmbedding": true,
      "imageS3Key": "face-events/images/event_123.jpg",
      "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "personUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "pitch": 15.5,
      "roll": 2.3,
      "selectedPersonMatch": {
        "confidence": 0.95,
        "faceId": "face_12345",
        "name": "John Doe",
        "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
      },
      "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
      "thumbnailS3Key": "face-events/thumbnails/event_123.jpg",
      "topPersonMatches": [
        {
          "confidence": 0.95,
          "faceId": "face_12345",
          "name": "John Doe",
          "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
        }
      ],
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "yaw": -5.7
    }
  ],
  "lastEvaluatedKey": "next_page_key_123"
}

Authorizations

x-auth-apikey
string
header
required

Your API key for Rhombus.

Headers

x-auth-scheme
string
default:api-token
required

Authentication scheme indicator ("api-token").

Required string length: 9

Body

application/json

Request object for finding face events by organization with search filtering and pagination.

pageRequest
object

Pagination request for retrieving similar face events

searchFilter
object

Search filter for face events with embedding presence filtering.

Response

200 - application/json

OK

Response object containing face events for an organization with pagination information.

faceEvents
object[] | null

List of face events matching the search criteria

lastEvaluatedKey
string | null

Pagination key for retrieving the next page of results

Example:

"next_page_key_123"