Introduction

Mental model

The platform is built from a few core entities:

A Thing is any device or asset you track: a battery, charger, meter, vehicle, etc.
Every Thing belongs to an Organization and lives in a Place (a Site or a Fleet).
Every Thing has a type: a Thing Type Definition that declares the Metrics it reports and the static Properties it carries. We call this the ontology.
An Integration connects an external system and feeds data into your Things.
Things emit telemetry: timestamped metric readings you send in and query back.

A typical integration follows four steps:

Define Ontology: register a Thing Type, what kind of device, and what metrics it reports
Register Thing: add an actual device of that type
Ingest data: send metrics from that Thing
Query data: read data, aggregates, and summaries

To make your first call, see the Quickstart.

Overview

What the platform does and the API you'll work with.

Core concepts

The domain model : Organizations, Sites, Fleets, and Things.

Data model

Thing Types, Metrics, and Properties : defining the ontology.

API fundamentals

Authentication, base URLs, versioning, IDs, pagination, and errors.

Ingesting data

The end-to-end path to get telemetry into the platform.

Querying data

Reading telemetry, aggregates, and summaries back out.

The API is REST over HTTPS, returns JSON, and is documented in the API Reference.
IDs are typed and prefixed: a Thing id looks like <thingId>, a Site like <siteId>.
Everything is multi-tenant: your credentials scope you to one organization, and you can only ever see your own data.