# Entryway Traffic

## Payload

The Traffic event follows a standardized JSON structure:

```json
{
  "id": "event_2oUBiSXgx48RtbZKXHm5ekpAzFe",
  "type": "TRAFFIC",
  "timestamp": 1727735832000,
  "version": "v1.0.0",
  "metadata": {
    "org_id": "org_2oUBiRES2AmpczNM5yLu7pChz8o",
    "site_id": "site_2oUBkdxF0lLJZxyWVix09ZTsMNV",
    "building_id": "building_2oUBkaFkcYwDzo7HLXpPh8bP4cD",
    "floor_id": "space_2oUBnI7YL51GNemTvKIxEgSZ8gx",
    "room_id": "room_2oUDDps5iKHHo6RwlMgGVihmTlq", // (optional)
    "floor_custom_id": "2tZStWPtxqpmb3w0PoJDm7AnfIX", // (optional)
    "room_custom_id": "2tZSGplhA4CZ58wFlTf7wAeKMVo",  // (optional)
    "hive_id": "hive_2oULLOWeATbeC4Ebfe849hNlFWk",
    "sensor_id": "2oULMisdkRfEp6mBag2gLpJ0d7Z",
    "org_name": "Murphy Group",
    "site_name": "Los Angeles",
    "building_name": "Bergnaum Building",
    "floor_name": "1st Floor",
    "room_name": "Cherry Falls", // (optional)
    "hive_serial": "21312f639defabc0",
    "mac_address": "00-17-0d-00-00-cc-bb-aa",
    "sensor_mode": "traffic",
    "sensor_model": "Heatic 2+",
    "hive_model": "2.0",
    "hive_version": "2.4.4"
  },
  "data": {
    "in": 0,
    "out": 1
  }
}
```

### Field Descriptions

#### Event Metadata

<table><thead><tr><th width="133">Field</th><th width="95">Type</th><th>Description</th></tr></thead><tbody><tr><td>id</td><td>string</td><td>Unique event identifier</td></tr><tr><td>type</td><td>string</td><td>Event type (e.g., "traffic")</td></tr><tr><td>timestamp</td><td>number</td><td>Timestamp of the event (in milliseconds)</td></tr><tr><td>version</td><td>string</td><td>Event version (e.g., "v1.0.0")</td></tr></tbody></table>

#### Organization and Location Metadata

<table><thead><tr><th width="172">Field</th><th width="167">Type</th><th>Description</th></tr></thead><tbody><tr><td>org_id</td><td>string</td><td>Unique organization identifier</td></tr><tr><td>site_id</td><td>string</td><td>Unique site identifier</td></tr><tr><td>building_id</td><td>string</td><td>Unique building identifier</td></tr><tr><td>floor_id</td><td>string</td><td>Unique floor identifier</td></tr><tr><td>room_id</td><td>string (optional)</td><td>Unique room identifier</td></tr><tr><td>floor_custom_id</td><td>string (optional)</td><td>Customer's unique floor identifier</td></tr><tr><td>room_custom_id</td><td>string (optional)</td><td>Customer's unique room identifier</td></tr><tr><td>hive_id</td><td>string</td><td>Unique hive identifier</td></tr><tr><td>sensor_id</td><td>string</td><td>Unique sensor identifier</td></tr><tr><td>org_name</td><td>string</td><td>Organization name</td></tr><tr><td>site_name</td><td>string</td><td>Site name</td></tr><tr><td>building_name</td><td>string</td><td>Building name</td></tr><tr><td>floor_name</td><td>string</td><td>Floor name</td></tr><tr><td>room_name</td><td>string (optional)</td><td>Room name</td></tr><tr><td>hive_serial</td><td>string</td><td>Hive serial number</td></tr><tr><td>mac_address</td><td>string</td><td>Sensor MAC address</td></tr><tr><td>sensor_mode</td><td>string</td><td>Sensor mode (e.g., "traffic")</td></tr><tr><td>sensor_model</td><td>string</td><td>Sensor's model (e.g., "Heatic 2+", "Heatic 2")</td></tr><tr><td>hive_model</td><td>string</td><td>Hive's model (e.g., "2.0", "1.0")</td></tr><tr><td>hive_version</td><td>string</td><td>Hive's software version</td></tr></tbody></table>

#### Traffic Data

<table><thead><tr><th width="88">Field</th><th width="103">Type</th><th>Description</th></tr></thead><tbody><tr><td>in</td><td>number</td><td>Number of people entering the area</td></tr><tr><td>out</td><td>number</td><td>Number of people exiting the area</td></tr></tbody></table>