Butlr Developer Docs

Butlr Developer Docs

• Welcome
• What is Butlr
• Spatial Metrics
• Getting Started
• Authentication
• Making your first query
• Mint Client Credentials: Client Credential Credential Grant via Butlr API
• MCP Server
• Changelog
• GraphQL API Overview
• Sites: You can use Butlr's GraphQL API to create, update, and retrieve information about sites.
• Buildings: You can use Butlr's GraphQL API to create, update, and retrieve information about buildings.
• Floors: You can use Butlr's GraphQL API to create, update, and retrieve information about floors.
• Rooms: You can use Butlr's GraphQL API to create, update, and retrieve information about rooms.
• Zones: You can use Butlr's GraphQL API to create, update, and retrieve information about zones.
• Hives: You can use Butlr's GraphQL API to create, update, and retrieve information about hives.
• Sensors: You can use Butlr's GraphQL API to create, update, and retrieve sensor information.
• Asset Tags
• Filtering
• Delete Resources
• Reporting API Overview
• Calibration Overview
• Realtime Calibration
• Floor Occupancy
• Room Occupancy
• Zone Occupancy
• Query Occupancy by Tag
• Traffic: https://api.butlr.io/api/v3/reporting
• Presence Time
• Statistic Overview
• Heatmap
• FAQs: Commonly Asked Questions about Reporting API v3
• Webhooks Overview: Butlr's webhooks deliver real-time data on key events, including occupancy and traffic data. Subscribing ensures automatic updates, timely insights, and structured data for informed decision-making.
• Area Detections: The Detections webhook event provides real-time updates on detected people's locations, represented by coordinates (x, y) within a sensor's field of view.
• Entryway Traffic: The Traffic webhook event provides real-time updates whenever someone enters or exits a monitored area.
• Floor Occupancy: The Floor Occupancy webhook event provides real-time updates on the number of occupants detected by the presence sensor on a specific floor.
• 1 Minute Interval: This event is the same as Floor Occupancy, but the data is aggregated at 1-minute granularity and smoothed to produce a single occupancy number for that minute.
• Room Occupancy: The Room Occupancy webhook event provides real-time updates on the number of occupants detected by the presence sensor in a specific room.
• 1 Minute Interval: This event is the same as Room Occupancy, but the data is aggregated at 1-minute granularity and smoothed to produce a single occupancy number for that minute.
• Zone Occupancy: The Zone Occupancy webhook event provides real-time updates on the number of occupants detected by the presence sensor on a specific zone.
• 1 Minute Interval: This event is the same as Zone Occupancy, but the data is aggregated at 1-minute granularity and smoothed to produce a single occupancy number for that minute.
• Motion Detection: The PIR Motion webhook event provides real-time updates indicating activity detected by the Heatic2+ sensor in a specific room.
• No Motion Detection: The PIR No Motion webhook event provides real-time updates when the Heatic 2+ sensor detects no activity in a specific room.
• Manage Webhooks: The Butlr platform provides self-service capabilities for managing webhooks through GraphQL API. Users can create, update, and delete webhooks programmatically.
• Create Webhooks: Create one or more new webhooks with specified configurations.
• Update Webhooks: Update existing webhooks with new configurations.
• Delete Webhooks: Delete one or more webhooks by their IDs.
• List Webhooks: Retrieve a list of all webhooks configured for your account.
• FAQs: Commonly Asked Questions about Webhook

Agent Instructions: Querying This Documentation

If you need additional information, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on a page URL with the ask query parameter:

GET https://docs.butlr.io/readme.md?ask=<question>

The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.