Introduction

This tutorial sets you up to use the Butlr API for programmatic access to your occupancy and asset data.

What you'll need

We use OAuth2.0 and JWT's to secure our API's, therefore you'll need the following:

• Username and Password provided by support@butlr.io
• Client id and Secret provided by support@butlr.io

Getting started

1. Get your access token
2. Query your assets:
   • POST - https://api.butlr.io/api/v3/graphql
     • Fixtures
     • Floors
     • Hives
     • Rooms
     • Sensors
     • Zones
3. Query your occupancy data:
   • POST - https://api.butlr.io/api/v3/reporting
     • Traffic

What is an asset?

An asset is a physical object that is connected to the Butlr platform. Assets can be anything from a sensor to a room to a hive. Assets are the building blocks of the Butlr platform, and they are the foundation of the data that is collected and analyzed by the Butlr platform.

Hierarchical structure

Some of these assets have not been implemented yet, but they are in the works. The hierarchy of assets is as follows: