Flussonic Watcher Video Analytics API

Faces

GET /vsaas/api/v2/analytics/faces

Returns list of Faces

Response JSON Object

• end_at (string (datetime))
• start_at (string (datetime))
• area_id (integer)
• camera_id (string)
• id (integer)
• person (object)
  • id (integer)
  • name (string)
• preview (dict)
• radius (float)
• vector (dict)
• weight (integer)

DELETE /vsaas/api/v2/analytics/faces/(int: id)

Deletes Face

Query Parameters

• id (integer) – Face identifier

PUT /vsaas/api/v2/analytics/faces/(int: id)

Set face data

Query Parameters

• id (integer) – Face identifier

Request JSON Object

• end_at (string (datetime))
• start_at (string (datetime))
• area_id (integer)
• camera_id (string)
• id (integer)
• person (object)
  • id (integer)
  • name (string)
• preview (dict)
• radius (float)
• vector (dict)
• weight (integer)

GET /vsaas/api/v2/analytics/faces/(int: id)

Returns a single face

Query Parameters

• id (integer) – Face identifier

Response JSON Object

• end_at (string (datetime))
• start_at (string (datetime))
• area_id (integer)
• camera_id (string)
• id (integer)
• person (object)
  • id (integer)
  • name (string)
• preview (dict)
• radius (float)
• vector (dict)
• weight (integer)

GET /vsaas/api/v2/analytics/faces/(int: id)/preview.jpg

Returns Face Preview

Response

image/jpeg Person Preview Image

Persons

POST /vsaas/api/v2/analytics/persons

Create a Person

Request JSON Object

• data (dict): form-data; name=”data”; filename=%any% Content-Type: image/jpeg
• external_id (string)
• name (string)
• note (string)
• person_category_id (integer)
• person_list_id (integer)

Response JSON Object

• id (integer)

GET /vsaas/api/v2/analytics/persons

Returns list of Persons

Query Parameters

• person_list – person_list - return persons only for selected list

• external_id – external_id - return persons only with selected external_id

• person_category – person_category - return persons only for selected person category

• utc_from – seconds since epoch in UTC - return only persons, appeared after selected time

• utc_to – seconds since epoch in UTC - return only persons appeared before selected time

Response JSON Object

• first_seen_at (string (datetime))
• last_seen_at (string (datetime))
• data (dict): form-data; name=”data”; filename=%any% Content-Type: image/jpeg
• external_id (string)
• id (integer)
• name (string)
• note (string)
• person_category_id (integer)
• person_list_id (integer)

DELETE /vsaas/api/v2/analytics/persons/(int: id)

Deletes person

Query Parameters

• id (integer) – Person identifier

PUT /vsaas/api/v2/analytics/persons/(int: id)

Request Form

• data (dict): form-data; name=”data”; filename=%any% Content-Type: image/jpeg
• external_id (string)
• name (string)
• note (string)
• person_category_id (integer)
• person_list_id (integer)

Response JSON Object

• id (integer)

GET /vsaas/api/v2/analytics/persons/(int: id)

Returns a single person

Query Parameters

• id (integer) – Person identifier

Response JSON Object

• first_seen_at (string (datetime))
• last_seen_at (string (datetime))
• cars (object array)
  • id (integer)
  • plate_number (string)
• category (object)
  • id (integer)
  • name (string)
• external_id (string)
• id (integer)
• name (string)
• note (string)
• person_category_id (integer)
• person_list (object)
  • config (dict)
  • id (integer)
  • name (string)
  • organization_id (integer)
• person_list_id (integer)

GET /vsaas/api/v2/analytics/persons/(int: id)/preview.jpg

Returns Person Preview

Response

image/jpeg Person Preview Image