Schemas

Release Description for current release page

S3 object key for the release media asset

Type of media asset (image or video)

Url to access the media asset

Optional call-to-action button label

Optional call-to-action URL. Use {systemId} as a placeholder for the active system.

Whether the CTA link should open in a new tab (external) or navigate within the app.

Unique identifier for the release

Release Title for current global operation

Array of objects containing respective descriptions and media for the release.

Release description for current release page

Existing S3 object key for the release media asset

Optional call-to-action button label

Optional call-to-action URL. Use {systemId} as a placeholder for the active system.

Whether the CTA link should open in a new tab (external) or navigate within the app.

Release Title for current global operation

Array of objects containing respective descriptions and media for the release.

Human-readable label for this key

First 8 chars of the key (for identification only)

Full API key — shown once only, store it securely

First 8 chars of the key (for identification only)

Primary ID of the UsageHistoryHour

No. What Hour (E.g. 7 means 0700 - 0800)

Status of the Plug (ON / OFF)

Type of device (PLUG, MCB, etc.)

Date Time of the Creation

Date Time of the Update

Date Time of the Update

MAC ID of the device

Reference to the device

WiFi signal strength at the time of the hourly record

Primary ID of the UsageHistoryDay

Usage History of the device (Hourly)

Date Time of the Creation

Date Time of the Update

Type of device (PLUG, MCB, etc.)

MAC ID of the device

Reference to the device

No. Hour of the Usage History

Total Energy Usage in a Day (kWh)

Energy cost for this day in dollars. Zero (0) if no tariff rate is configured for this day.

Energy Usage on phase A in a Day (kWh)

Energy Usage on phase B in a Day (kWh)

Energy Usage on phase C in a Day (kWh)

Active Energy consumed in a Day (Wh)

Reactive Energy consumed in a Day (VARh)

Apparent Energy consumed in a Day (VAh)

Tariff rate applied for this day in cents per kWh/L. Null if no tariff rate is configured.

No. Hour of the Usage History

Total Energy Usage in a Day (kWh)

Energy Usage on phase A in a Day (kWh)

Energy Usage on phase B in a Day (kWh)

Energy Usage on phase C in a Day (kWh)

Active Energy consumed in a Day (Wh)

Reactive Energy consumed in a Day (VARh)

Apparent Energy consumed in a Day (VAh)

No. Hour of the Usage History

Total Energy Usage in a Hour (kWh)

Energy Usage on phase A in a Hour (kWh)

Energy Usage on phase B in a Hour (kWh)

Energy Usage on phase C in a Hour (kWh)

Active Energy consumed in a Hour (Wh)

Reactive Energy consumed in a Hour (VARh)

Apparent Energy consumed in a Hour (VAh)

Array of hourly usage data

Current tariff rate in cost per kWh. Null if no tariff rate is configured. Useful for frontend calculations.

Status of the device (ON / OFF)

Date Time of the Creation

Current in Amperes (A)

Voltage in Volts (V)

Power factor (0-1)

Power in Watts (W)

Phase A voltage (V)

Phase B voltage (V)

Phase C voltage (V)

Phase A current (A)

Phase B current (A)

Phase C current (A)

Phase A active power (W)

Phase B active power (W)

Phase C active power (W)

Phase A reactive power (VAR)

Phase B reactive power (VAR)

Phase C reactive power (VAR)

Phase A apparent power (VA)

Phase B apparent power (VA)

Phase C apparent power (VA)

Phase A power factor (0-1)

Phase B power factor (0-1)

Phase C power factor (0-1)

Line frequency (Hz)

WiFi RSSI value at the time of the reading (dBm)

Energy consumed by the device over the selected period

Cost of the selected period, in dollars

Tariff rate applied, in cents per kWh

Record tier the figure was integrated from

Length of the selected period in seconds

Seconds of the period actually backed by data. Falls short of windowSeconds when the device was offline or reporting sparsely.

coveredSeconds / windowSeconds, 0–1

Number of source records in the period

Projection assuming this rate of draw continues around the clock.

Projection assuming this exact period repeats once per day — the figure to read as "savings if scheduled off".

Scope level that supplied the rate. Null when no level of the scope chain has a rate and the national default was used.

Mean power across the covered part of the period, in watts. Realtime resolution only.

Highest instantaneous power in the period, in watts. Realtime resolution only.

Summed power at this timestamp in Watts (W)

MCB measurement type for this series, or "COMBINED" for the total across all types

Maximum power value across all data points in this series (W). Only present for the COMBINED series.

Average power value across all data points in this series (W). Only present for the COMBINED series.

Type of device (PLUG, MCB, etc.)

Peak power in the range (W)

Mean power across the range (W)

Measurement type, for MCBs only

One time-series per MCB measurement type found in the room or zone, plus a COMBINED series that sums all types

Per-device breakdown of the same range, for charting the selection split out. Present only on endpoints that provide it. A phase child rolls up into its parent clamp, since the rows belong to the clamp.

Device ids to read. PLUG and MCB only — other types write no energy realtime rows. Max 20: each id widens a high-frequency time-series scan.

Range start

Range end

One-liner summary of room energy behaviour

List of predicted devices and why

Total energy consumed by the device in watt-hours.

Total energy usage in kWh

Total cost based on current tariff rate. Null if no tariff rate is configured.

Current tariff rate in cost per kWh. Null if no tariff rate is configured.

Hour of the day (0–23)

Device on/off status for this hour

Record creation timestamp

Total downtime in milliseconds for this hour (3600000 = full hour down)

Gang switch states reported by the device (array index = gang index, 1 = ON, 0 = OFF)

Actual date this hourly record is for

Device on/off status

Record creation timestamp

Ambient temperature in Celsius

Ambient humidity percentage

Whether motion was detected (MAXWELL_ULTRA only)

WiFi RSSI value at the time of the reading (dBm)

Occupancy estimate. Absent when the device carries no people counter

Hour of the day (0–23)

Device on/off status for this hour

Record creation timestamp

Total downtime in milliseconds for this hour (3600000 = full hour down)

Ambient temperature in Celsius

Ambient humidity percentage

Whether motion was detected during this hour (MAXWELL_ULTRA only)

Actual date this hourly record is for

Median occupancy over the hour. Prefer over the average — robust to walk-by bursts

Mean occupancy over the hour, rounded

Minimum occupancy over the hour

Maximum occupancy over the hour

Settled occupancy figures that fed the hourly aggregate; a low count is a low-confidence hour

Hour of day, 0-23

Mean signal in this hour slot across the window, in dBm

Worst reading in this slot, in dBm — where a dropout actually starts

Hourly snapshots that contributed. Low counts are weak evidence.

Mean signal across the window, dBm

Hourly snapshots carrying a signal reading

Hours in the window with no hourly record at all. A device that stops reporting has no weak reading to show — the silence is the signal.

Hour-of-day slots that carried data. Absent hours are omitted, not zeroed.

Hours spanned by the window, the denominator for missingHours

Devices in the system that reported any signal in the window

Weakest average signal first, so dead spots sort to the top

Present and true when devices were dropped by limit. Never silently truncated — raise limit or narrow the window.

Hour of the day (0–23)

Number of distinct entities with data in this hour

Hourly box plot entries (only hours with data)

Aggregated value for this entity in the hour

Overall box plot statistics across all entities in the hour

Per-entity breakdown

Hour of the day this record covers (0–23, e.g. 7 = 0700–0800)

Date the hourly bucket belongs to

Record creation timestamp

WiFi signal strength at the time of the hourly record, in dBm

Average temperature for the hour, in degrees Celsius

Average humidity percentage for the hour

Average CO2 for the hour, in ppm

Average light level for the hour, in lux (lx)

Average formaldehyde (HCHO) for the hour, in µg/m³

Average PM1 for the hour, in µg/m³

Average PM2.5 for the hour, in µg/m³

Average PM10 for the hour, in µg/m³

Average total volatile organic compounds for the hour, in ppb

Average sound level for the hour, in dB

Whether motion was detected during the hour

Start timestamp of the downsampled bucket

Average temperature for the bucket, in degrees Celsius

Average humidity percentage for the bucket

Average CO2 for the bucket, in ppm

Average light level for the bucket, in lux (lx)

Average formaldehyde (HCHO) for the bucket, in µg/m³

Average PM1 for the bucket, in µg/m³

Average PM2.5 for the bucket, in µg/m³

Average PM10 for the bucket, in µg/m³

Average total volatile organic compounds for the bucket, in ppb

Average sound level for the bucket, in dB

Whether any sample in the bucket detected motion

Average WiFi RSSI for the bucket (dBm)

Hour of the day this record covers (0–23, e.g. 7 = 0700–0800)

Device on/off status during this hour

Net water volume for this hour (L)

Average flow rate for this hour (m³/h)

Average flow velocity for this hour (m/s)

Average speed of sound for this hour (m/s)

Average signal quality for this hour (no units)

Average thermal energy flow rate for this hour (GJ/h)

Total thermal energy for this hour (GJ)

Average inlet water temperature for this hour (°C)

Average outlet water temperature for this hour (°C)

Date the hourly bucket belongs to

Record creation timestamp

Device on/off status at the time of the reading

Flow rate at the time of the reading (m³/h)

Flow velocity at the time of the reading (m/s)

Speed of sound in fluid at the time of the reading (m/s)

Ultrasonic signal quality (no units)

Record creation timestamp

Whether the meter is physically connected

Inlet water temperature (°C)

Outlet water temperature (°C)

Thermal energy flow rate (GJ/h)

WiFi RSSI value at the time of the reading (dBm)

Total net water volume for the day (L)

Average flow rate for the day (m³/h)

Average flow velocity for the day (m/s)

Average speed of sound for the day (m/s)

Average signal quality for the day (no units)

Hourly rows this daily aggregate was rolled up from

Total thermal energy for the day (GJ)

Average thermal energy flow rate for the day (GJ/h)

Average inlet water temperature for the day (°C)

Average outlet water temperature for the day (°C)

Start of the day this aggregate covers

Timestamp of the last update to this aggregate

Full name of the administrator

Email address for the administrator account (must be unique)

Account password (minimum 6 characters, optional for invited admins)

Administrator role defining access permissions (SUPERADMIN or ADMIN)

Frontend app context for app-specific signup flows

Unit name for B2C signup — used as the zone name for the user's space

Whether the user accepted the Terms & Conditions. Required (must be true) for base (B2C) self-signup.

Whether the admin account is approved and can access the system

Optional zone ID to associate this admin with a specific zone account

Optional tenant ID to associate this admin with a specific tenant

Optional room ID to associate this admin with a specific room

Indicates if the login was successful

User ID of the authenticated user

Main system ID associated with the user

Indicates if the user has 2FA enabled and needs to complete 2FA verification

JWT access token. Returned to clients that carry their own credentials — native apps identifying as beacon, and any caller that sends no app. A web app that names itself via app receives this as an httpOnly cookie instead and gets no copy here, since a copy readable by JavaScript is what httpOnly exists to prevent. The exception is the pre-2FA step, whose short-lived 10-minute token is returned to every caller because it is not yet a session.

Role of the authenticated user

Email of the authenticated user

Associated tenant ID if user has TENANT role

Associated user ID if user has USER role

Associated room ID if user has ROOM_ADMIN role

Refresh token used to obtain a new access token. Absent when 2FA verification is still pending, and absent for web callers, which receive it as an httpOnly cookie scoped to /api/auth instead.

How many seconds the access token remains valid, counted from when this response was issued. Returned to every caller, including web ones that receive no token at all — a cookie client cannot read the token to find its exp, so this is how it knows when to refresh ahead of a 401. Relative rather than absolute, matching OAuth 2.0 expires_in, so a client whose clock disagrees with the server still refreshes at the right moment. A lifetime is not a credential, so exposing it costs nothing. Absent when the response carries no session (pending approval, or 2FA still to complete).

Administrator email address used for authentication

Administrator password (minimum 6 characters)

Frontend app identifier for role-based access control

The refresh token to revoke alongside the access token. Optional so existing cookie/header callers keep working; when present it is blacklisted so it can no longer be exchanged.

The 30-day refresh token issued at login. Exchanged for a fresh access + refresh token pair. The presented token is revoked (single use). Optional: browser clients omit it and the token is read from the httpOnly refresh cookie instead.

ID of the administrator sending the invitation

System ID where the new admin will have access

Full name of the person being invited

Email address where the invitation will be sent

Role to be assigned to the new administrator (SUPERADMIN or ADMIN)

Optional zone ID to link this admin account to an existing zone

Optional tenant ID to associate this admin with a specific tenant for billing

Optional room ID to associate this admin with a specific room

ID of the Admin that is inviting

ID of the System

Email of the Admin

Reset password token for the Admin

Password of the Admin

Whether the user accepted the Terms & Conditions. Sent by the base (B2C) create-account page.

Email of the Admin

Reset password token for the Admin

New password for the Admin

Google Identity Services ID token (JWT credential) obtained client-side via the GIS button. Verified server-side against the configured Google client ID.

Frontend app identifier for role-based access control

Microsoft Identity Platform id_token (JWT credential) obtained client-side via the native OAuth flow. Verified server-side against Microsoft’s JWKS for the pinned tenant.

Frontend app identifier for role-based access control

Issuer for the 2FA secret

Label for the 2FA secret

2FA secret

Success message

Success message

Number of users whose 2FA was disabled

Primary ID of the audit log entry

The action that was performed

Whether the action succeeded or failed

When the action occurred

Account that performed the action

Display name of the acting account (resolved from actorId)

Role of the actor at the time of the action

System the action was scoped to

Name of the system the action was scoped to

Type of resource the action targeted

ID of the targeted resource

Trigger source for device actions

Free-form contextual data; shape varies by action

Total count of items matching filters

Current page number

Items per page

Total number of pages

Array of audit log entries matching the query parameters

Role of the message sender

Content of the message

The user's current message

Array of previous messages in the conversation (max 30 messages)

Category ID

Unique category key

Human-readable display name

Whether this is a built-in category

Creation timestamp

Admin who created this category

Unique category key — must be UPPER_SNAKE_CASE

Human-readable display name

Human-readable display name

Auto-calculated threshold (median) in kWh

Default number of violations to trigger flagging

Default rolling window in days for violation counting

Manual threshold override in kWh (if provided)

Local time of day (HH:mm, in the system timezone) the digest fires at. Anchors the every-N-days digest so it no longer inherits the moment the config was saved.

Local date (YYYY-MM-DD, system timezone) of the first digest run. Picks which day of the N-day cycle the digest lands on; defaults to the next occurrence of digestTime.

Sentinel power range rules for suspected device classification

Per-type-key overrides, keyed by the entity type key (e.g. TYPE_A). An entity whose type key has no entry here — including entities with no type key at all — uses the baseline above.

Location of the Tenant

Type of the Tenant

Geolocation of the Tenant

Primary ID of the feature

Name of the feature

Type of the feature

Description of the feature

Indicates the creation time of the feature

Indicates the last update time of the feature

The unique identifier of the subscription tier

The name of the subscription tier