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, timing, 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

The endpoint returns a JSON array of charging event objects, ordered according to the sort_field and sort_order parameters. Use take and skip to page through the results.

json
[
  {
    "TransactionID": 123456,
    "SiteName": "Berlin Depot",
    "ChargerType": "AC",
    "ChargerID": "charger-01",
    "ConnectorID": 1,
    "StartAt": "2026-01-01T08:00:00.000Z",
    "EndAt": "2026-01-01T11:30:00.000Z",
    "InitialSoC": 20,
    "BusID": "Fleet Vehicle 7",
    "EndSoC": 85,
    "EnergyDelivered": 42.5
  }
]

Data

Each charging event contains the following fields:

FieldTypeDescription
TransactionIDnumberUnique identifier for the charging transaction
SiteNamestring | nullDisplay name of the site where the session occurred
ChargerTypeAC | DC | nullWhether the charger is AC or DC
ChargerIDstringID of the charging station
ConnectorIDnumberConnector number on the charging station
StartAtstring (ISO 8601)Start time of the charging session
EndAtstring (ISO 8601)End time of the charging session
InitialSoCnumber | nullState of charge at the start of the session (%)
BusIDstring | nullIdentifier associated with the session, derived from the RFID tag name
EndSoCnumber | nullState of charge at the end of the session (%)
EnergyDeliverednumber | nullTotal energy delivered during the session (kWh)

Sort Fields

The sort_field query parameter accepts the following values. Sorting is applied to the underlying session record, so some sort keys (e.g. cost, duration) are valid even though they are not returned in the response body:

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