Face Recognition Event Webservice

Find face events by organization

Find face events for an organization. The events are returned in reverse chronological order, with the latest events appearing first.

post/api/faceRecognition/faceEvent/findFaceEventsByOrg

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/faceRecognition/faceEvent/findFaceEventsByOrg
  • Auth: API key in header x-auth-apikey

Headers

x-auth-scheme'api-token' | 'api' | 'partner-api-token' | 'partner-api' required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Request body

Example request

{
  "searchFilter": {
    "deviceUuids": [
      "AAAAAAAAAAAAAAAAAAAAAA.v0"
    ],
    "locationUuids": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "personUuids": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ]
  }
}

Response

OK

lastEvaluatedKeystring nullable

Pagination key for retrieving the next page of results

Example response

{
  "faceEvents": [
    {
      "detectionConfidence": 0.98,
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
      "embeddingConfidence": 0.95,
      "eventTimestamp": 1640995200000,
      "hasEmbedding": true,
      "imageS3Key": "face-events/images/event_123.jpg",
      "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "personUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "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"
    }
  ],
  "lastEvaluatedKey": "next_page_key_123"
}

Changes

No recorded changes to this operation across all 1 revision of this API.