What is Mapped?

How it Works

Mapped Console

Mapped for Developers

Whats is GraphQL?

How to Make a GraphQL request

Introduction

Authorization overview

Using a Token

Viewing access tokens

Deleting access tokens

Updating access token scopes

Security

How authorization and security work in the Mapped API

Authentication & Security

Mapped will be adding the ability to detect and track people in the near future, while respecting all local privacy and data regulations.

People - detecting & tracking individuals as they move through a place

People

Sites

Buildings

Floors

Spaces

Place Subtypes

Places - the elements of your environment

Places

View things by place

Viewing things by type

Viewing model or manufacturer

Things - each individual device that generates data and sends it to Mapped

Things

Series

Aggregation

Using the State Text Field

Identifying Unit of Measure

DataType

Points represent the value of a device, like the temperature on a thermostat

Points

Zones - non-structural regions such as areas covered by cooling systems

Zones

Filtering using a single criteria

Stacking filters

Filtering for multiple matches

Filtering to omit matches

Walkthrough guide on how to use filtering

Filtering

Place Relationships

Thing Relationships

Feeds & Serves Relationships

Showing how different types relate to each other

Relationships

Create sites, buildings, floors and spaces using API calls

Place Management

Enabling & Using the Sandbox

Sandbox Details

How to use the sandbox and details about the data

Sandbox

Viewing Connectors

Viewing Things & Points by Connector

Outlining how to use work with connectors via the API

Connectors

Viewing gateways

Viewing a specific gateway's details

Assigning a gateway

Suspending a gateway

Gateways connect your buildings to the Mapped Cloud

Gateways

Creating a Live Query

Alternate Creation Method Using @Live

View Existing Live Queries & Last Result

Updating a Live Query

Pausing & Resuming a Live Query

Deleting a Live Query

Using a Live Query with a Webhook

Live Queries

Working with the Webhooks UI

Creating Webhooks Through the API

View Existing Webhooks Through the API

Updating Webhooks Through the API

Deleting Webhooks Through the API

Webhook Payload Examples

Detailed walkthrough for creating webhooks using the UI or API.

Webhook Guide

Viewing your organization details

Editing your organization details

Organizations - the top level of your data.

Organization

Viewing Users

Inviting Users

Viewing Invites

Updating Invites

Deleting Invites

Editing users

Adjusting user roles

Deleting users

Adding, editing or removing Users in your Organization

Users

General FAQ

Developer FAQ

General and Developer specific Frequently Asked Questions

FAQs

Documentation covering the use of the Mapped API

Documentation

Personal Access Token

Webhooks

GraphQL Explorer

Tools

Use Cases

Configuration

Mapped Concepts

Sample Code

Provides air quality sensor data for environments around buildings.

Airly

Track indoor air quality and radon levels in your building

Airthings

Access indoor air quality data from Awair sensors

Awair

Stream your Mapped data to Azure Event Hub

Azure Event Hub - Destination

Beacon

Access live occupancy and people count data for your workspaces

Butlr

Schema

Business Rules

Other Considerations

Use the CSV Connector to import data to Mapped use CSV files

CSV Connector

Provides location and occupancy services, along with sensor data like temp, humidity and Co2

Disruptive Technologies

Energy Star Portfolio Manager Destination Connector allows you to send energy and water usage data to the Portfolio Manager application to generate metrics.

Energy Star Portfolio Manager - Destination

Energy Star Portfolio Manager allows you to retrieve meter data and EPA metrics available in the Portfolio Manager application.

Energy Star Portfolio Manager - Source

Feenics Access Control

Connect your Kaiterra indoor air quality sensors to access to temperature, humidity, and air quality data.

Kaiterra

View access control event data pertaining to buildings, floors and spaces

Kastle

Monitor energy demand and consumption across buildings. Electricity, and water utilities are covered.

MACH Energy

View access control data pertaining to your buildings/floors/spaces

OpenPath

Robin is a hybrid workplace experience platform that has features for desk reservations and spatial intelligence.

Robin

Connect buildings in France to national energy metrics

RTE France EcoMix

Swift Sensors

IoT platform to connect your sensors for review and analytics

Tago.io

Monitor energy demand and consumption across your buildings portfolio. Electricity, gas and water utilities are covered.

Utilivisor

VergeSense

View Glass provides automated tinted windows for large buildings.

View Glass

The View Sense connector allows you to connect to your View Sense AO, EQ, and PM devices to your Mapped graph

View Sense

Vutility

Virtual weather station allows you to retrieve weather data per building

Weatherbit

Access indoor air quality data from CO2 sensors, particulate matter sensors, etc.

WellStat

XY Sense provides sensors for Occupancy and Indoor Air Quality

XY Sense

Yanzi

Covering the purpose and use of each Connector

Connector Guides

Guide on how to pick the right type of gateway to suit the network

Selecting the Type of Gateway

Initial set of questions and notes prior to gateway install

Gateway Installation Precheck

System Requirements

Network Access

Docker Deployment

Kubernetes Deployment

View Secure Edge Deployment

Instructions for configuring and installing the UG-CLOUD software gateway

Container / Software Gateway Installation Guide

Deploying the VM

Instructions for configuring and installing the UG-CLOUD Virtual Machine gateway

Virtual Machine Gateway Installation Guide

Instructions for configuring and installing the UG-100 physical gateway

Hardware / Physical Gateway

How the Mapped Gateway avoids network impact

Mitigating Network Impact

Supported Protocols

Api endpoint to retrieve Mapped's active hostnames and IP address

Retrieving Hostnames & IPs

Explains how the mapped gateway connects to networks

BBMDs & Foreign Device Registration

FQDNs

Cloudlink

Hostname Details

Documentation for the setup and administration of physical or virtualized gateways