Skip to content

Charging Events

Context

The Charging Events API provides access to completed charging session records for your sites. Each event represents a single transaction — from the moment a charging session starts to the moment it ends — and includes energy, cost, ID, and state-of-charge data where available.

Available Endpoints

  • GET /charging-events/site/{id} - Retrieve charging events for a specific site

Returns a paginated list of charging events for the given site, filtered by time range and optionally searchable and sortable.

Path Parameters

ParameterTypeRequiredDescription
idstringYesThe ID of the site for which to retrieve charging events

Query Parameters

ParameterTypeRequiredDescription
fromstring (ISO 8601)YesStart of the time range
tostring (ISO 8601)YesEnd of the time range
search_textstringNoFree-text search across charging event data (max 100 characters)
sort_fieldstringNoField to sort results by — see Sort Fields
sort_orderasc | descNoSort order for results
takenumberNoNumber of records to return (max 1000)
skipnumberNoNumber of records to skip, for pagination

Response

json
{
  "charging_events": [
    /* array of charging event objects */
  ],
  "count": 42,
  "truncated": false,
  "dto_presence": true
}
FieldTypeDescription
charging_eventsarrayList of charging event objects
countnumberTotal number of matching records
truncatedbooleanWhether the result set was truncated due to size limits
dto_presencebooleanWhether dynamic tariff optimisation (DTO) data is present for this site

Data

Each charging event contains the following fields:

Core Fields

FieldTypeDescription
transaction_idnumberUnique identifier for the charging transaction
occurrence_timestring (ISO 8601)Timestamp of when the transaction was recorded
start_timestring (ISO 8601)Start time of the charging session
stop_timestring (ISO 8601)End time of the charging session
durationnumberDuration of the session in seconds
transaction_dataobjectRaw transaction data from the charger

Site & Charger Fields

FieldTypeDescription
site_idstringID of the site where the session occurred
site_namestringDisplay name of the site
charger_idstringID of the charging station
charger_namestringDisplay name of the charging station
charger_current_typeAC | DCWhether the charger is AC or DC
connector_idnumberConnector number on the charging station
connector_namestringDisplay name of the connector

Energy & Metering Fields

FieldTypeDescription
energy_consumednumberTotal energy delivered during the session (kWh)
meter_startnumberMeter reading at the start of the transaction (Wh)
meter_stopnumberMeter reading at the end of the transaction (Wh)
invalid_meter_readingbooleanWhether the meter readings for this session were flagged as invalid
start_socnumberState of charge at the start of the session (%)
stop_socnumberState of charge at the end of the session (%)

RFID Fields

FieldTypeDescription
rfidstringRFID tag used to authenticate the session
rfid_namestringDisplay name associated with the RFID tag
rfid_additional_informationstringAdditional metadata associated with the RFID tag

Cost & Optimisation Fields

FieldTypeDescription
costnumberActual cost of the charging session
optimized_costnumberCost of the session had dynamic tariff optimisation (DTO) been applied
cost_savingsnumberDifference between cost and optimized_cost
dto_optimizedbooleanWhether this session was optimised using dynamic tariff optimisation

Sort Fields

The sort_field query parameter accepts the following values:

ValueDescription
occurrence_timeSort by when the event was recorded
rfidSort by RFID tag
rfid_nameSort by RFID tag display name
energy_consumedSort by energy delivered
durationSort by session duration
costSort by actual cost
optimized_costSort by DTO-optimised cost
cost_savingsSort by cost savings