# Welcome

Butlr’s privacy-first people-sensing platform seamlessly integrates with your needs—whether you’re optimizing space utilization, improving energy efficiency, or generating actionable insights across workplaces, senior living, and retail environments. With intuitive APIs, event-driven webhooks, and dedicated support, we enable you to unlock new possibilities.

Together, let’s create a smarter, more responsive built environment.

**Helpful Resources to Get Started**

We’ve curated essential resources to ensure a smooth and successful integration with the Butlr platform. Whether you’re exploring our APIs for the first time or diving into advanced use cases, these guides will help you hit the ground running:

<table data-view="cards"><thead><tr><th></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td>Learn how Butlr’s privacy-first people-sensing platform transforms spaces with real-time occupancy data and actionable insights.</td><td><a href="https://3289302098-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fe3YixUK5tCcflJxye0bT%2Fuploads%2Fgit-blob-5be00f2d9e604284f352fbee7ecd8d0d234870db%2Fwhat%20is%20butlr.png?alt=media">what is butlr.png</a></td><td><a href="what-is-butlr">what-is-butlr</a></td></tr><tr><td>Learn the available spatial metrics and their calculation methods based on the deployed sensor mode.</td><td><a href="https://3289302098-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fe3YixUK5tCcflJxye0bT%2Fuploads%2Fgit-blob-cf4ef5879d0151355068accd4a56623255e87681%2FSpatial%20metrics.png?alt=media">Spatial metrics.png</a></td><td><a href="spatial-metrics">spatial-metrics</a></td></tr><tr><td>Step-by-step instructions for integrating occupancy data into your applications.</td><td><a href="https://3289302098-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fe3YixUK5tCcflJxye0bT%2Fuploads%2Fgit-blob-2f0ab445578b2f3196844a8b37e2c84b0b3f2374%2Fgetting%20started.png?alt=media">getting started.png</a></td><td><a href="getting-started">getting-started</a></td></tr><tr><td>A complete reference guide to our <strong>Graph QL API</strong>, covering endpoints, authentication, and sample requests.</td><td><a href="https://3289302098-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fe3YixUK5tCcflJxye0bT%2Fuploads%2Fgit-blob-2cd35476b339e8d0be1f364462970610a4f84575%2FAsset%20mgmt.png?alt=media">Asset mgmt.png</a></td><td><a href="../what-is-butlr#graphql-api">#graphql-api</a></td></tr><tr><td>Learn how to access aggregated data and generate detailed usage reports through our <strong>Reporting API</strong>.</td><td><a href="https://3289302098-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fe3YixUK5tCcflJxye0bT%2Fuploads%2Fgit-blob-eefa7bd63d57515e0fada4d12c8c9f0a34a8bc57%2FHistorical%20Occupancy.png?alt=media">Historical Occupancy.png</a></td><td><a href="https://github.com/butlrtechnologies/butlr-api-docs/blob/master/broken-reference/README.md">https://github.com/butlrtechnologies/butlr-api-docs/blob/master/broken-reference/README.md</a></td></tr><tr><td>Learn how to set up event-triggered <strong>webhooks</strong> for real-time data delivery.</td><td><a href="https://3289302098-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fe3YixUK5tCcflJxye0bT%2Fuploads%2Fgit-blob-492f690210cd6d9c8e85c0f78dbbf6868b878377%2FReal-time%20Occupancy.png?alt=media">Real-time Occupancy.png</a></td><td><a href="https://github.com/butlrtechnologies/butlr-api-docs/blob/master/broken-reference/README.md">https://github.com/butlrtechnologies/butlr-api-docs/blob/master/broken-reference/README.md</a></td></tr></tbody></table>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current 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.