GraphQL API Overview
Last updated
Last updated
The Butlr GraphQL API is designed for efficient resource data management. It enables querying and mutating specific details about assets such as buildings, floors, rooms, sensors, and hives. This is particularly useful for developers who need customized queries and mutations to build tailored applications or integrate data into existing systems. It provides fine-grained control over the data you request, making it ideal for scenarios where you need specific information and the ability to manipulate data efficiently.
At the core of the Butlr data model is a spatial hierarchical framework that mirrors the management of physical assets —starting with individual sensors in specific zones or rooms and scaling up to encompass entire floors, buildings, and even larger campuses or regional portfolios. This model allows for granular data collection and analysis at every level, from detailed room-level occupancy to aggregated insights across buildings or campuses.
An organization is at the highest level in the data model hierarchy, representing the entity that owns and manages the Butlr hardware.
An organization can have one or multiple users, all of whom have administrative privileges by default within their assigned organization. We plan to introduce more granular user role controls in 2025.
An organization can have one or many sites. A site is defined as a group of buildings located within a contiguous area, such as a campus or city blocks, all situated within the same time zone.
A site can have one or many buildings. A building is an individual structure within a site, consisting of one or multiple floors.
A building can have one or multiple floors. A floor is an individual level within a building containing one or more rooms and zones.
A floor can have one or many enclosed rooms. A room is typically enclosed by walls that serve a specific purpose, such as an office, conference room, or bedroom.
A zone is a designated subsection within a room or floor, it is used to segment larger areas for more granular monitoring. Zones may represent specific areas like seating sections, workstations, or entry points.
A Hive is associated with a specific floor within a building. It is the central hub for managing and transmitting data from sensors to the cloud, ensuring efficient communication and data processing.
A sensor can be associated with a floor, room, or zone. This flexibility allows for effective monitoring across different areas, from general traffic at floor entrances to pinpointing specific occupancy locations within a zone.
For a comprehensive list of all endpoints, visit https://graphql-docs.butlr.io/graphql/
