Skip to main content
PUT
Update history

Authorizations

x-api-key
string
header
required

Send your API key in the x-api-key header of every request. The key belongs to one Orbital account, and requests act as that account: they see and control only the devices it owns or has been given access to. A missing or unknown key gets 403 with { "message": "Forbidden" }.

Path Parameters

id
string
required

ID of the session record, id in the history lists

Body

application/json
feedback_rating
number

Rating of the session. The Orbital app uses whole stars from 1 to 5.

Example:

5

feedback_text
string

Comment on the session.

Example:

"Perfect temperature"

updated_at
string

When the change was made (ISO 8601).

Example:

"2026-10-28T17:03:10.000Z"

Response

Success

id
string

ID of the session record. Use it with PUT /client/history/{id} and GET /client/history-metadata/{id}.

Example:

"1730530800000"

session_id
string

ID of the session.

Example:

"1730530800000"

timestamp
string

When the session started (ISO 8601).

Example:

"2026-11-02T06:20:00.000Z"

type
string

Kind of session, shower for a shower session. The history lists only return shower sessions.

Example:

"shower"

session_type
string

Kind of session as reported by the shower, SHOWER for a shower session. Not set by older showers.

Example:

"SHOWER"

shower_id
string<uuid>

ID of the shower.

Example:

"0b7a6c1e-5f2d-4c3b-8a9e-1d2f3a4b5c6d"

saved_water
number

Water saved by recirculating, in litres.

Example:

42.5

saved_energy
number

Energy saved by recirculating, in kWh, after subtracting the electricity the shower used. 0 when nothing was saved.

Example:

1.84

active_duration
number

Time spent showering, in seconds.

Example:

420

avg_temperature
number

Average water temperature while showering, in °C.

Example:

38.2

avg_user_temperature
number

Average temperature setpoint while showering, in °C.

Example:

38

filter_status
number

Filter life left after the session, in percent (0–100).

Example:

72

feedback_rating
number

Rating of the session. The Orbital app uses whole stars from 1 to 5.

Example:

5

feedback_text
string

Comment on the session.

Example:

"Perfect temperature"