System Details

Retrieves a system summary

Returns system summary based on the specified system ID and summary date. For historical requests i.e summary date is in the past the fields modules, size_w and current_power are returned as zero.

get/api/v4/systems/{system_id}/summary

Request

Path parameters

system_idinteger required

The unique numeric ID of the system

Query parameters

summary_datestring

Requested date for the system's summary data. Defaults to the current local date of the system

Response

System summary fetched

system_idinteger

The unique numeric ID of the system

current_powerinteger

Current power production of the system in Watts

energy_lifetimeinteger

Energy generated by the system during its lifetime till one day before to the requested summary date in Wh

energy_todayinteger

Energy generated by the system on requested summary date in Wh

last_interval_end_atinteger

The last known time that the system produced energy. When a system has not been communicating for a length of time, the last_report_at can be recent, whereas the last_interval_end_at may be further back.

last_report_atinteger

Timestamp (in epoch format) at which the system's Envoy last submitted a report

modulesinteger

Total number of modules in the system

operational_atinteger

Timestamp (in epoch format) at which this system became operational. Corresponds to the system’s interconnect time, if one is specified. Otherwise, it is the system’s first reported interval end time.

size_winteger

System size in watts

nmiinteger

National Meter Identifier

sourcestring

Source of energy measurement

statusstring

Current status of the system

stageinteger

Current stage of the system. Stage values indicate the system's progression through the activation process.

summary_datestring

Summary date

battery_charge_winteger

Maximum charge power of all the batteries of the system in watts

battery_discharge_winteger

Maximum discharge power of all the batteries of the system in watts

battery_capacity_whinteger

Total capacity of all the batteries of the system in watt-hours

Changes

No recorded changes to this operation across all 1 revision of this API.