Appearance
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
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The ID of the site for which to retrieve charging events |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
from | string (ISO 8601) | Yes | Start of the time range |
to | string (ISO 8601) | Yes | End of the time range |
search_text | string | No | Free-text search across charging event data (max 100 characters) |
sort_field | string | No | Field to sort results by — see Sort Fields |
sort_order | asc | desc | No | Sort order for results |
take | number | No | Number of records to return (max 1000) |
skip | number | No | Number of records to skip, for pagination |
Response
json
{
"charging_events": [
/* array of charging event objects */
],
"count": 42,
"truncated": false,
"dto_presence": true
}| Field | Type | Description |
|---|---|---|
charging_events | array | List of charging event objects |
count | number | Total number of matching records |
truncated | boolean | Whether the result set was truncated due to size limits |
dto_presence | boolean | Whether dynamic tariff optimisation (DTO) data is present for this site |
Data
Each charging event contains the following fields:
Core Fields
| Field | Type | Description |
|---|---|---|
transaction_id | number | Unique identifier for the charging transaction |
occurrence_time | string (ISO 8601) | Timestamp of when the transaction was recorded |
start_time | string (ISO 8601) | Start time of the charging session |
stop_time | string (ISO 8601) | End time of the charging session |
duration | number | Duration of the session in seconds |
transaction_data | object | Raw transaction data from the charger |
Site & Charger Fields
| Field | Type | Description |
|---|---|---|
site_id | string | ID of the site where the session occurred |
site_name | string | Display name of the site |
charger_id | string | ID of the charging station |
charger_name | string | Display name of the charging station |
charger_current_type | AC | DC | Whether the charger is AC or DC |
connector_id | number | Connector number on the charging station |
connector_name | string | Display name of the connector |
Energy & Metering Fields
| Field | Type | Description |
|---|---|---|
energy_consumed | number | Total energy delivered during the session (kWh) |
meter_start | number | Meter reading at the start of the transaction (Wh) |
meter_stop | number | Meter reading at the end of the transaction (Wh) |
invalid_meter_reading | boolean | Whether the meter readings for this session were flagged as invalid |
start_soc | number | State of charge at the start of the session (%) |
stop_soc | number | State of charge at the end of the session (%) |
RFID Fields
| Field | Type | Description |
|---|---|---|
rfid | string | RFID tag used to authenticate the session |
rfid_name | string | Display name associated with the RFID tag |
rfid_additional_information | string | Additional metadata associated with the RFID tag |
Cost & Optimisation Fields
| Field | Type | Description |
|---|---|---|
cost | number | Actual cost of the charging session |
optimized_cost | number | Cost of the session had dynamic tariff optimisation (DTO) been applied |
cost_savings | number | Difference between cost and optimized_cost |
dto_optimized | boolean | Whether this session was optimised using dynamic tariff optimisation |
Sort Fields
The sort_field query parameter accepts the following values:
| Value | Description |
|---|---|
occurrence_time | Sort by when the event was recorded |
rfid | Sort by RFID tag |
rfid_name | Sort by RFID tag display name |
energy_consumed | Sort by energy delivered |
duration | Sort by session duration |
cost | Sort by actual cost |
optimized_cost | Sort by DTO-optimised cost |
cost_savings | Sort by cost savings |