For the complete documentation index, see llms.txt. This page is also available as Markdown.

Overview

The Integrations API serves historical data from third-party sensors that are installed in your Butlr spaces, such as desk occupancy, motion, and temperature sensors. These sensors sit in the same site → building → floor → room hierarchy as your Butlr hardware, and add one level below it: the spot.

Base URL: https://api-integrations.butlr.io (HTTPS only)

Endpoint
Purpose

Time-series data: occupancy, temperature, door/window activity, events, and device heartbeat

Which Reporting API should I use?

Reporting API (Historical Occupancy)
Integrations Reporting API

Data from

Butlr sensors

Third-party sensors

Endpoint

POST https://api.butlr.io/api/v3/reporting

POST https://api-integrations.butlr.io/api/v1/reporting

Request shape

measurement, window, filter

Flat JSON: measurements, items, start, stop, interval

Aggregation

You choose a function (sum, mean, …) in window

Pre-computed: every statistic (min, max, mean, …) comes back as its own field

Response

Rows per series

data object keyed by entity ID

Errors

See that API's docs

{"errors": [{"code": …, "description": "…"}]}: -2/-3 for authentication, -5xxx for everything else

Supported sensors

Sensor
What you can query

Desk occupancy

Desk occupancy per spot, rolled up to room and floor

Motion

Motion occupancy per spot, rolled up to room and floor

Temperature

Temperature per sensor, room, and floor

Door/window contact

Door/window opening counts per room and floor

All third-party sensors

Cleaning alerts generated from traffic and door/window data can also be queried.

Next steps

  1. Spots & Sensor Placement: how third-party sensors map to your spaces, and the IDs you query with.

  2. Authentication & Rate Limits: get a token and stay within limits.

  3. Reporting API Overview: make your first request.

Last updated