Error Events

Context

The Error Events API provides access to the same error events that are available through the ChargePilot Dashboard under the Error Events section. An error event is raised when a local controller goes offline, or when a charging station or one of its connectors reports a fault, and it is closed again once the asset recovers.

Each event is identified by an event_id. Use the list endpoint to find events for a site, then the detail endpoint to retrieve the full record for a single event.

Available Endpoints

• GET /error-events/site/{id} - Retrieve error events for a specific site
• GET /error-events/site/{id}/{event_id} - Retrieve a single error event

GET /error-events/site/{id}

Returns a paginated list of error 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 error events

Query Parameters

Parameter	Type	Required	Description
start_date	string (ISO 8601)	Yes	Start of the time range
end_date	string (ISO 8601)	Yes	End of the time range
search_text	string	No	Free-text search across device ID, error message, and charging point name (max 100 characters)
sort_field	string	No	Field to sort results by — see Sort Fields
sort_order	asc | desc	No	Sort order for results (defaults to desc)
take	number	No	Number of records to return (max 200)
skip	number	No	Number of records to skip, for pagination

Response

{
  "events": [
    {
      "event_id": "0f1c1f2e-9c4a-4a1f-8a1e-2f0f9b0f3c11",
      "error_status": "active",
      "device_id": "a1b2c3d4",
      "charging_point_name": "Charging Point 1",
      "error_message": "GroundFailure",
      "error_date": "2026-05-15T10:00:00.000Z",
      "automatic_recovery_status": "initiated",
      "site_name": "Depot North",
      "case_type": "connector_error"
    }
  ],
  "records_count": 42
}

Field	Type	Description
events	array	List of error event objects
records_count	number	Total number of matching records

GET /error-events/site/{id}/{event_id}

Returns the full record for a single error event, including when it was resolved and any vendor-specific error information reported by the charging station.

Responds with 404 if no error event exists for the given event_id.

Path Parameters

Parameter	Type	Required	Description
id	string	Yes	The ID of the site the error event belongs to
event_id	string	Yes	The ID of the error event, as returned in event_id by the list endpoint

Response

{
  "site_name": "Depot North",
  "controller_id": "a1b2c3d4",
  "charger_id": "charger-1",
  "charging_point_name": "Charging Point 1",
  "error_status": "recovered",
  "error_message": "GroundFailure",
  "error_occurred": "2026-05-15T10:00:00.000Z",
  "error_resolved": "2026-05-15T11:00:00.000Z",
  "automatic_recovery_status": "initiated",
  "automatic_recovery_time": "2026-05-15T10:30:00.000Z",
  "case_type": "connector_error",
  "vendor_error_code": null,
  "vendor_info": null
}

Data

Error Event

Each entry in the events array contains the following fields:

Field	Type	Description
event_id	string	Unique identifier for the error event
error_status	string	Whether the error is ongoing — see Error Status
device_id	string	ID of the local controller or charging station that reported the error
charging_point_name	string	Display name of the affected charging point
error_message	string	The reported error, typically an OCPP error code (e.g. GroundFailure, Offline)
error_date	string (ISO 8601)	When the error occurred
automatic_recovery_status	string	See Automatic Recovery Status
site_name	string	Display name of the site
case_type	string	What kind of asset failed — see Case Types

Error Event Detail

The single-event endpoint returns the following fields:

Field	Type	Description
site_name	string	Display name of the site
controller_id	string	ID of the local controller managing the affected asset
charger_id	string	ID of the affected charging station
charging_point_name	string	Display name of the affected charging point
error_status	string	Whether the error is ongoing — see Error Status
error_message	string	The reported error, typically an OCPP error code
error_occurred	string (ISO 8601)	When the error occurred
error_resolved	string (ISO 8601)	When the error was resolved, or null while it is still active
automatic_recovery_status	string	See Automatic Recovery Status
automatic_recovery_time	string (ISO 8601)	When the most recent automatic recovery was attempted. This does not indicate whether the attempt succeeded
case_type	string	What kind of asset failed — see Case Types
vendor_error_code	string	Vendor-specific error code reported by the charging station, where available
vendor_info	string	Additional vendor-specific error information, where available

Any field may be null when the underlying data is not available.

Error Status

Value	Description
active	The error is ongoing and the asset has not recovered
recovered	The asset has recovered and the error is closed

Case Types

Value	Description
controller_error	The local controller went offline
charger_error	The charging station reported an error or fault
connector_error	A connector on the charging station reported an error or fault

Automatic Recovery Status

ChargePilot attempts to recover some errors automatically, for example by restarting an affected charging station.

Value	Description
initiated	An automatic recovery has been triggered for this error
not_initiated	No automatic recovery has been triggered — either it does not apply to this error, it is still pending, or a previous attempt did not complete

Sort Fields

The sort_field query parameter accepts the following values:

Value	Description
error_date	Sort by when the error occurred
error_status	Sort by error status
device_id	Sort by device ID
charging_point_name	Sort by charging point name
error_message	Sort by error message
case_type	Sort by case type
site_name	Sort by site name
automatic_recovery_status	Sort by automatic recovery status