Skip to main content
GET
Get history metadata

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

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"

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"