API Reference

Core Concepts

Get occupancy and spatial information for your Lambent-powered spaces.

The Lambent API is a RESTful JSON API, and supports cross-origin resource sharing. Standard HTTP verbs are used to perform CRUD operations, and the API returns standard HTTP response codes to indicate errors.

Analyze API


Spaces API

Lambent exposes the Spaces API for working with spaces and space information. Lambent defines Spaces as real-world physical structures—from regions, buildings, floor levels, and zones within a floor level.

Regions

Lambent defines a region as a geographical location, having one or more buildings. For example, a corporate business might have locations in New York, London, and Hong Kong—each location assigned to a region. Educational institutions might use regions for campuses. For instance, The Phoenix campus and the Flagstaff campus would be assigned their own region.

Buildings

Lambent defines a building as a physical structure with at least one floor level. One or more buildings can exist within a region. Buildings can be anything from a single-story structure to multi-story skyscrapers.

Levels

Lambent defines a level as a single floor level within a building. Usually, floors within a building are discrete and obvious. However, Lambent also supports split-level and more nuanced orientations.

Zones

Lambent defines a zone as one or more areas within a level, and associated with wireless access point devices (WAPs). Depending on the number and density of WAPs, zones encapsulate WAP coverage. With dense WAP coverage, zones sometimes map 1-to-1 with physical rooms. However, in most cases, a zone will encapsulate multiple rooms.