Quividi offers 4 different APIs. Please click on each heading for more information and access to the technical documentation. 

  • Real Time API
    • This API describes the position, demographic profile and attention behavior of each detected person, up to 15 times per second. 

    • It is designed to be used for triggering content within a 3rd party application, such as a CMS.

      Different modes are available to address different use cases: 

      • Periodic (the description of each watcher including is position is provided regularly – typically every second)
      • Motion (same as periodic, but for every frame processed, typically 15 times per second - which is prefered for applications that require fast reactivity)
      • Final events (the description of the viewing session is provided once the watcher has just left the scene)
      • Aggregate (a count of the watchers and the breakdown of their demographic is given since the start of the application)
      • Demo (the image of the video stream can be passed along – subject to privacy legislation)

  • CMS API

    • First and foremost, The CMS API is a way for a third party (typically a CMS) to notify VidiReports of currently playing content so that this may be correlated with the audience in VidiCenter’s data. More details here

    • You also have two sub-APIs:

      • Post bid API: when the CMS notifies VidiReports it has ended playing a content, the audience detected during its playtime is returned to it, split by demographics, in order for the CMS to report on the effective impressions through its own programmatic pipeline.
        This API is an evolution of the Audience Per Content API.
      • Pre-bid API: this API provides a short term prediction of the audience of this screen, split by demographic (2 genders x 7 age groups), so that DPS or SSPs can decide how to price that slot.

  • Cloud API (Network Data API)
    • This API exports data from VidiCenter at various granularity levels : audience data, content data, monitoring data, etc. 

      • Watchers and OTS API: this API exports audience and traffic data, down to the content level.  The time granularity can be set from one month down to one second.

      • Monitoring API: this API outputs some monitoring values (such as percentage of light, CPU usage, presence of camera, etc) and is meant to be used in alert workflows.

      • Clip Metadata API: this API makes it possible to complete the content ID captured by the Content API with other metadata (such as the name of the content), in order to make Audience per content reports easier to read. More information here.

  • Local Status API
    • This API lets a 3rd party application receive information on the inner operations of the local VidiReports instance. 

    • The API gives access to :

      • current status
      • video resolution
      • license permissions
      • last and next uploads
      • lighting conditions
      • etc.
    • You can found the manual for this API here


  • OEM API
    • This API is meant for CMS publishers to integrate their software provisioning system with VidiReports, so that pre-deployed VidiReports installations can be tied to player installations without additional user intervention. It actually consists of two APIs: 
      • one on the edge (VidiReports), which passes all the needed information for a new instance to self register;
      • one on the cloud (VidiCenter), which is called from the vendor’s backend, upon request from the user to enable Quividi audience measurement on a player.
    • The OEM API include the Charts API: this API delivers values of a series of standard charts and tables, either as PNG images or JSON data, with the goal to easily embed them in 3rd party apps.
  • You can found more details about the OEM API here



---

Quividi also have a legacy Audience API, now replaced by the CMS API. As such, it is not supported and should not be used.


Audience Per Content API - LEGACY

  • This API links contents to watchers in order to report on the audience of a particular content, such as a DOOH campaign. 

  • The Audience Per Content API is used by CMS to pass along the ID of the content they are playing, so that Quividi can provide a deep understanding of the performance of each content and campaign in VidiCenter.

  • Customers can later upload content metadata (such as the content's name) into VidiCenter, in order to provide for nice-to-read reports.