Skip to main content
GET
/
api
/
partners
/
v2.0
/
org
/
{org_id}
/
users
/
{user_id}
/
wallboxes
/
{wallbox_id}
/
hems-sessions
/
{session_id}
Get one standalone HEMS session with its decision timeline and command verdicts
curl --request GET \
  --url https://api.example.com/api/partners/v2.0/org/{org_id}/users/{user_id}/wallboxes/{wallbox_id}/hems-sessions/{session_id} \
  --header 'Authorization: Bearer <token>'
{
  "session": {
    "id": 123,
    "ocpp_transaction_id": 123,
    "started_at": "2023-11-07T05:31:56Z",
    "ended_at": "2023-11-07T05:31:56Z",
    "final_hems_state": "<string>",
    "energy_from_solar_kwh": 123,
    "savings_eur": 123,
    "has_complete_price_coverage": true,
    "commands_sent": 123,
    "commands_applied": 123,
    "commands_ineffective": 123
  },
  "decisions": [
    {
      "time": "2023-11-07T05:31:56Z",
      "hems_state": "<string>",
      "reason": "<string>",
      "export_w": 123,
      "target_w": 123,
      "phases": 123,
      "dispatched": true,
      "steering_command_id": 123
    }
  ],
  "commands": [
    {
      "id": 123,
      "time": "2023-11-07T05:31:56Z",
      "commanded_watts": 123,
      "commanded_amps": 123,
      "commanded_phases": 123,
      "dispatch_status": "<string>",
      "observed_current_offered_a": 123,
      "observed_power_w": 123
    }
  ]
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

org_id
string<uuid>
required

The organization ID

user_id
string<uuid>
required

The user ID

wallbox_id
string<uuid>
required

The wallbox ID

session_id
integer
required

The HEMS session ID

Response

200 - application/json

OK

session
HEMSSessionItem · object
required
decisions
HEMSDecisionItem · object[]
required
commands
HEMSCommandItem · object[]
required