Release Notes
      Back to home
      1. Learning Center
      2. Release Notes

      API Release Notes

      API Docs https://docs.butlr.io | API URL https//api.butlr.io

      February 17, 2023

      API v2 

      The following endpoints have been improved for faster and more reliable performance. No downtime is expected.

      • PUT -/spaces/{space_id} 
      • POST-/v3/graphql

      February 4, 2023

      API v2 

      The following endpoints have been improved for faster and more reliable performance. No downtime is expected. 

      • GET-spaces/space_id/sensors
      • GET-spaces/space_id/sensors/sensor_id

      February 1, 2023

      API v2

      We are deprecating the following legacy endpoints. These are currently not in use by customers and will not affect any features or system performance.

      • GET - api/v2/spaces/{id}/hives
      • GET - api/v2/space/{id}/hives/{id}

      January 31, 2023

      API v2

      The following endpoints have been improved for faster and more reliable performance. No downtime is expected.

      • GET - api/v2/spaces/{id}/fixtures
      • GET - api/v2/spaces/{id}/fixtures/{id}

      January 26, 2023

      API v2

      The following endpoints have been improved for faster and more reliable performance. No downtime is expected.
      • GET - api/v2/sensors
      • GET - api/v2/sensors/{id}
      • GET - api/v2/spaces/{id}/rooms
      • GET - api/v2/spaces/{id}/rooms/{id}
      • GET - api/v2/spaces/{id}/sensors
      • GET - api/v2/spaces/{id}/sensors/{id}

      August 22, 2022

      API v2

      New token request endpoint for API consumers on client-credentials (M2M) grant flow.
        • We have introduced a new endpoint to interact with in order to request a token. This feature is to help us internally solve the token minting inefficiencies we were experiencing.
        • We would highly encourage all consumers of this API through client-credentials grant flow (aka CLIENT_ID and CLIENT_SECRET provided by Butlr) to test/migrate over to the new API (https://api.butlr.io/api/v2/clients/login), in order to obtain the access tokens necessary to interact with the Butlr API. We will eventually require this to be the standard for all consumers in the future

        • How to use: https://docs.butlr.io/#operation/post-clients-login

          Example: https://docs.butlr.io/#section/Authentication

      July 29, 2022

      API v3

      A new version of our API is now available! While all existing endpoints are available via API v2, API v3 now offers this new feature:

      • New /reporting endpoint: customize data aggregation by filtering (filter), grouping order (group_by) and results aggregation time window (window).

      API v2

      • New /zones endpoint: supports the ability to create zones, or subregions of a room (such as desks, soft seating, etc.), on Studio, and track occupancy data of individual zones.
        Note: Zone-building feature in Studio and charts on dashboard are currently in development.
      • Minor bug fixes and security enhancements

      June 30, 2022

      API v2

      • New /supported-languages endpoint: list of the various languages that Butlr supports
      • New /preferences endpoint: store the user's preferred language
      • New /refresh endpoint to get fresh access_token / id_token / refresh_token
      • Minor bug fixes

      March 2022

      API v2

      A new version of our API is now available! 

      • The use of hive_id is not required any more
      • Any clients using the .dev links should switch to .io.
      • Query by (space_id AND room_id) or just (space_id) to identify sensor groupings for time series endpoints like occupancy, headcount, and streams.
      • Receive room_id and space_id information in query response when requests are made with space_id/room_id together, just room_id, or hive_id/device_id together.
      • TimeRange parameter has been deprecated.
      • Timezone (tz) feature now available to display any desired timezone.
      • Time representation in query returns now shows the suffix "00:00" to depict a UTC time instead of 'Z' character.