Changelog
Last updated
Last updated
New Release:
We are introducing the stats API under reporting. The stats API will give an aggregate view of occupancy data over the specified time range.
How to Use It
.
Impact
No breaking changes
Clients can use this API to query for aggregate occupancy statistics over a period of time
We’ve introduced a Calibrated Occupancy option that enhances the accuracy of traffic-based occupancy data across your spaces.
How to Use It
Developers can now enable calibrated:true by adding in as filter in calls to relevant traffic-based endpoints.
What It Does
Over time, miscounts from entry and exit sensors can build up, especially in busy areas with multiple entrances. This can lead to:
Occupancy appears to drop to zero too early
Spaces showing as occupied even after everyone has left
This new calibrated model helps correct for these discrepancies, delivering occupancy counts that more closely reflect real-world usage patterns.
Key Benefits
More accurate traffic-based occupancy trends
Improved reliability in areas with complex traffic flows
Better alignment with actual space usage throughout the day
New Release:
We’ve introduced new metadata fields to our webhook messages to provide additional customer-specific context. These fields allow for better mapping of data to customer-defined locations.
Added Fields:
floor_custom_id → Customer’s unique floor identifier
room_custom_id → Customer’s unique room identifier
zone_custom_id → Customer’s unique zone identifier
Impact:
No breaking changes.
Existing webhook message structure remains unchanged, ensuring backward compatibility.
Clients can now utilize these additional fields to enhance data integration.
New Features Released:
Legacy v2 APIs Deprecation The following endpoints will reach their end-of-life on Friday, October 11th, 2024:
v2/spaces
v2/hives
v2/sensors
All sub-resources of the above endpoints.
Important Note: All Login, Reporting, and Detections endpoints will remain functional and supported. Please update your integrations accordingly.
Fixtures Endpoint Deprecation The fixtures endpoint, including objects and sub-resources associated with floors (formerly known as spaces), reached its end-of-life on Friday, September 20th, 2024.
Context: This feature was part of our previous installation tool, which was deprecated earlier in 2024. There is no replacement functionality for fixtures.
Please review your implementation to ensure compatibility with the latest APIs. For questions or assistance, contact our support team at support@butlr.io
Receive instant updates on occupancy changes for seamless integration and automation.
: Assign one or more tags to floor, room, and zone assets, enabling better organization and categorization of spaces.
Query presence-based occupancy data for floors, rooms, and zones by tag, providing powerful insights tailored to specific categories or use cases.