Version: 1.0
Last updated: 30th Nov, 2020

Introduction

Supervue is an Ai assisted solution which gives an extremely powerful view of your security and surveillance systems. It drastically reduces manual monitoring efforts by 99% and enables proactive threat detection.

Our module has a SOTA performance on WLFW and NIST-mugshot datasets with accuracy upto 99.83% and 97.8% respectively. This module outperformed many major FR-competitors in terms of accuracy when benchmarked internally.

API Reference

The Supervue APIs are organized around RESTful APIs. Our APIs have predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

HTTP Status Code

Supervue uses conventional HTTP response codes to indicate the success or failure of an API request.

Status code 200 indicates success.

Codes in the 4xx range indicate an error that failed due to any of the conditions following coditions:

  • Missing required parameters.
  • A valid API key is not provided or the API key doesn't have permissions to perform the request.
  • Requested resource doesn't exist.
  • The request conflicts with another request.

Codes in the 5xx range indicate an error with server.

HTTP Status Code Summary
200 - OK. 400 - Bad Request. 401 - Unauthorized. 402 - Request Failed. 403 - Forbidden. 404 - Not Found. 409 - Conflict. 429 - Too Many Requests. 500, 502, 503, 504 - Server Errors.

Webhooks

What is a webhook?

A webhook is a user-defined URL callback. It is a mechanism that enables apps to receive data updates in real time through a URL call. Webhooks can be incredibly helpful when you're working with data updates that need to be notified immediately.

Get started
  • Create a webhook endpoint on your server.
  • Supervue POSTs data to your endpoint in JSON format. Full event details are included in payload.
  • POST event should return 200 status code to acknowledge receipt of an event.
  • Use supervue test payload to test that your endpoint works.

    The payload structure remains same in the live and test modes.

  • Register your endpoint in supervue dashboard and select event types you want to be notified to go live.

Supervue Event Notifications Service (SENS)

Supervue Event Notifications Service (SENS) can be used to receive notifications from supervue platform when certain events occur. Setup your environment to be notified for selected event categories.

Supported notification events

  1. Transactional Events
  2. Engagement Events
  3. Violation Events

SENS API post callback has 5 seconds timeout to process an event and return HTTP 200 response indicating successful processing.

SENS retries upto three times to deliver an event in case of unsuccessful processing. After 3 consecutive failed retries, event will not be posted.

Ensure that your client ID and secret key are stored securely(if provided). Never expose this information on client-side code.

Violation Events

The Social Distance Monitor (SDM) event violation payload 200 status response schema:

  • Supervue Event Notifications Service Id
  • Event Id
  • Client Id
  • Camera Id
  • Event Category
  • Event Timestamp
  • Number of People Identified
  • Number of People at High Risk
  • Number of People at Medium Risk
  • Number of People at Low Risk
Test Your Webhook
Endpoint
URL: https://webhookUrl.io/events
SDM Violation Event Payload
{ "sens_id": "2aef52dd-ae20-40de-9574-631d1776751b", "object": "violation_event", "api_version": "1.0", "pending_events": 0, "timestamp": "2020-11-26T06:07:08.141555+00:00", "data": { "object": { "event_details": { "event_id": "23232423231", "event_category": "sdm", "client_id": "18", "cam_id": "325", "event_timestamp": "2020-11-26T06:07:08.141555+00:00" }, "event_analysis": { "no_persons": "18", "peopleAtLowRisk": "9", "peopleAtMediumRisk": "6", "peopleAtHighRisk": "3" }, "event_violations": { "peopleAtMediumRisk": "6", "peopleAtHighRisk": "3" } } } }