Skip to main content
Table of Contents

V5

The API provides a flexible, and developer‑friendly interface for programmatically accessing environmental measurement and device data stored in ZENTRA Cloud 2.0

Travis Bates
Updated by Travis Bates

V5 will be available soon!

API Overview

The ZENTRA Cloud v5 API is the latest-generation data interface from METER Group, designed to provide faster, more consistent access to environmental and device data.

Environmental and Device Data

v5 offers unified access to environmental time-series data and device metadata. Its cleaner, more intuitive structure reduces integration complexity—whether you're migrating an existing system or building a new data pipeline.

Built for Growth

The v5 API powers ZENTRA Cloud 2.0 and supports high-volume device networks and enterprise-scale workflows. Its modern features and extensible architecture ensure that building on v5 gives you the most capable and future-ready foundation for your applications.

Rate Limiting

The Generic Cell Rate Algorithm (GCRA) is precise, burstable rate limiting algorithm. It tracks a "Theoretical Arrival Time" (TAT) for each client and allows requests as long as they do not arrive "too early" according to the configured rate. GCRA is widely used in telecommunications, API gateways, and distributed systems where fairness and precise burst control are required.

v5 has a burst limit of 5, and a steady state rate of 1 call per minute.

How GCRA Works in v5

  • Initial Burst Allowance: Clients can make up to 5 immediate requests without delay if they have been idle. This is the allowed burst capacity.
  • Steady‑State Rate: After the burst capacity is consumed, additional requests are limited to the steady rate of 1 request per minute.
  • Burst Reset Behavior: The burst allowance fully resets if no requests are made for a period equal to burst_limit × 60 seconds (for 5 bursts, this is 300 seconds).
  • After this idle period, clients regain the ability to make all 5 burst requests immediately.
  • Handling Early Requests: If a request arrives sooner than allowed by the GCRA schedule, the algorithm calculates a next time to call timestamp. The client must wait this long before the next request will be accepted.

How to get started

Data Access Control

Access to device data is controlled via the organization. Your user account must be a member of the organization that the device belongs to, and your role in that organization must be Editor or Administrator.

Create Account

Follow our Getting Started guide:

Where to Find Your API Key

API Token Keys are provided per user. Your API Key can be found under your ZENTRA Cloud user account, under Integrations. You can copy the token ID or regenerate the token ID.

Try it Out

Parameters

device_id

string

(path)

The unique identifier of the device.

Example : z6-12345

direction

string

(query)

Order by which logs are retrieved and displayed by date. Available values: ascending, descending .

Default value: descending

start_datetime

(query)

An ISO datetime string. A start datetime without a timezone will be considered as having a UTC timezone.

Users should not input both datetimes and timestamps, only one or the other.

Example: 2025-10-20T17:15+00:00

or

Example: 1737367200000

end_datetime

(query)

An ISO datetime string. An end datetime without a timezone will be considered as having a UTC timezone.

Users should not input both datetimes and timestamps, only one or the other.

Example: 2025-10-20T17:15+00:00

or

Example: 1737367200000

start_timestamp

(query)

Unix timestamp representing seconds since Jan. 1, 1970 00:00 UTC.

Users should not input both datetimes and timestamps, just one or the other.

Example: 1763445086

end_timestamp

(query)

Unix timestamp representing seconds since Jan. 1, 1970 00:00 UTC.

Users should not input both datetimes and timestamps, just one or the other.

Example: 1763445086

next_token

(query)

The string needed to get the next pagination set.

limit

integer

(query)

maximum: 1000

Number of datapoints to return.

Default value: 1000

Example: 2

latest

boolean

(query)

Coming Soon!

Returns the latest datapoint, supersedes datetime and timestamp parameters.

Default value: false

Example: true

expand

(query)

Coming Soon!

Gives more information on the field passed.

Example: settings

units

string

(query)

The units that the data will return in. Available values: metric, imperial

Default value: metric

Example: imperial

How did we do?

Integrations

Contact