Skip to content

Event Schema

Events are single items designed by its timestamp.

They contain a series of properties of a certain type.

Properties of type keyword can be indexed and used for filters.

Properties of type text are associated to the event, but should not be used for filtering.

Keywords of the kind <property>_id represent objects in Broox Studio (Playlists, Campaigns...) and are unique internal IDs. Those are associated with their respective <property> which is the user facing name of the object ~at the time of the event~.

  • @timestamp (date_nanos): Event timestamp.
  • store_id (keyword, indexed): Broox Studio ID of the Location.
  • store_name (text): Broox Studio User Facing Name of the Location.
  • store_city_country (text): Broox Studio User Facing City (Country) of the Location (if set).
  • audience_id (keyword): Broox Studio Unique audience ID.
  • audience_name (text): Broox Studio Audience User Facing Name.
  • campaign_id (keyword, indexed): Broox Studio Campaign ID.
  • campaign_name (text): Broox Studio Campaign User Facing Name.
  • installation_id (keyword, indexed): Broox Studio Installation ID.
  • installation_name (text): Broox Studio user facing Installation name
  • playlist_id (keyword): Broox Studio Playlist ID.
  • playlist_name (text): Broox Studio Playlist name.
  • canvas_id (keyword): Media Player Canvas unique id related to the event.
  • canvas_name (text): Media Player Canvas user facing name related to the event.
  • client_id (keyword): Account id.
  • client_name (text): User facing Account name.
  • trigger_name (text): User facing Studio Trigger name.
  • trigger_type (keyword): Kind of trigger (profile, sensor, udp...).
  • controller (text): Broox Controller identifier that generated the event.
  • month (keyword): Month of the year, 1-12.
  • day (keyword): Day-of-month, 1-31.
  • hour (keyword): Hour of the day, 0-23.
  • weekday (keyword): Day of the week, 0-6
  • year (keyword): Year of the event, YYYY
  • ev_category (keyword): Event category: One of profile (for Vision Node), sensor (for Sensor Node), media for Media Player, etc...
  • ev_action (keyword): Action associated with the event, e.g. in, out, try,....
  • media_id (keyword): For events of ev_category==media, the unique ID of the media (video, picture...).
  • media_idle (boolean): For events of ev_category==media, true if the media is the standby/default one..
  • media_name (text): For events of ev_category==media, the name of the media (e.g. Video3.mpg). .
  • has_face (boolean): For events of ev_category==profile, wether the detected actor has a visible face.
  • is_view (boolean): For events of ev_category==profile, wether the detected actor was looking at a defined target (screen).
  • target_age (integer): Actor inferred age (0-100).
  • target_gender (keyword): Actor inferred gender (M/F).
  • target_attention (double): Actor percent of time looking at media.
  • target_attention_time (double): Total time in seconds actor is been looking at media.
  • target_distance (double): Inferred distance to the camera, in meters.
  • target_dominant_emotion (keyword): Inferred actor dominant emotion (sad, angry, neutral...)
  • target_dwell (double): Total time in seconds of presence of the actor in camera.
  • target_features (keyword): Comma separated list of actor detected attributes (depends on detector used).
  • target_action (keyword): Action(s) being performed by the actor.
  • target_id (text): Unique anonymous id of the actor.
  • target_type (keyword, indexed): Detected element: face, person, skeleton, etc.
  • zone_hits (keyword, indexed): List of zone names that the actor has passed by/interacted.
  • zone_dwell (object): Map of zone names to total time in seconds spent inside by the actor.
  • full_media_views (keyword, indexed): List of media names completetely watched.
  • partial_media_views (keyword, indexed): List of media names partially watched (at least 5 seconds).
  • session_action (keyword): For session events, either start of finish.
  • area (text): Area hit by actor (deprecated, see zone_hits).
  • area_action (keyword): Action performed: enter, exit (deprecated).
  • change (integer): Increment or decrement of a given counter (deprecated).
  • interaction (keyword): Unused (deprecated).