Developers Early access

Your fleet's data, in your own systems

The Data API gives read-only access to the processed data of the devices your organization has enrolled: levels, pours, rollups and events. Build your own dashboards and reports, or feed dispatch and ERP systems. No dashboard required, and API access is included with every Connected device.

Getting started

Standard and predictable

Base URL
https://api.telemetryontap.com/v1
Format
JSON over HTTPS, read-only. Errors as RFC 7807 problem details.
Authentication
OAuth 2.0 client credentials. Each credential is scoped to your organization, and can be narrowed to specific devices and data areas.
Incremental sync
Cursor-based feeds for pours and events, so you fetch only what changed since your last call.
Stability
v1 is a frozen contract. Breaking changes ship as a new version, and the previous version keeps running for at least 12 months.
Limits
300 requests per minute per credential. Events are kept for at least 400 days.

What you can read

Resources in v1

Fleet

Your devices and their current state

  • GET /v1/fleet/devices
  • GET /v1/fleet/devices/{uid}

Inventory

Product levels, low flags, consumption rates and predicted empty times

  • GET /v1/inventory/levels
  • GET /v1/inventory/devices/{uid}/levels

Usage

Individual pours, an incremental pour feed, and daily rollups by device, site, organization or product

  • GET /v1/usage/dispenses
  • GET /v1/usage/dispenses/feed
  • GET /v1/usage/daily

Monitoring

Product, machine, maintenance, connectivity and fault events, with an incremental feed

  • GET /v1/monitoring/events
  • GET /v1/monitoring/events/feed

Account

Who the credential is and which organizations it can see

  • GET /v1/account/me
  • GET /v1/account/organizations

Example

Two calls to your first data

# 1. Exchange your client credentials for a token (token URL is issued with your credential)
curl -s -X POST "$TOKEN_URL" \
  -d grant_type=client_credentials \
  -d client_id="$CLIENT_ID" -d client_secret="$CLIENT_SECRET" \
  -d scope="$API_SCOPE"

# 2. Read current product levels across your fleet
curl -s https://api.telemetryontap.com/v1/inventory/levels \
  -H "Authorization: Bearer $TOKEN"

Request API access

The Data API is in early access. Tell us what you want to build and we will issue credentials for your organization.

Talk to usCompare plans