Skip to content
/
List command logs for an...

List command logs for an EVSE

Request

List the historical command logs for a specific EVSE. These logs record commands that were sent to the EVSE.

Security
oauth2(Required scopes: debug:read)
Path
evse_idstringevse[A-Z\d]{26}required

The ID of the specific EVSE to retrieve.

Example:evse01HSH04KDEWF6Z4DB2J77J74K5
Query
page_beforestring[a-z]{4}[A-Z\d]{26}

Return results from the page after this ID.

Example:page_before=xmpl01HNFZM7Q8FXASZXYZ6XM3TQRR
page_afterstring[a-z]{4}[A-Z\d]{26}

Return results from the page before this ID.

Example:page_after=xmpl01HNFZM7Q8FXASZXYZ6XM3TQRR
page_sizeinteger, [ 1 .. 100 ]

Specify the number of results to return per page.

Default:25
Example:page_size=10
logged_at__gtestring, (date-time)

Filters for logs logged at or after this datetime.

Example:logged_at__gte=2024-04-17T09:39:45.984584Z
logged_at__ltestring, (date-time)

Filters for logs logged at or before this datetime.

Example:logged_at__lte=2024-04-17T09:39:45.984584Z
expandArray of strings

Specify a url field to expand into a nested resource.

Items Enum:"evse""evse.model""evse.model.make""evse.user"
Headers
EvEnergy-Versionnumber

Specify the version of this endpoint to use.

Value:2
curl -i -X GET \
  'https://developers.ev.energy/_mock/ev.energy-api-v2/evses/evse01HSH04KDEWF6Z4DB2J77J74K5/command_logs?page_before=xmpl01HNFZM7Q8FXASZXYZ6XM3TQRR&page_after=xmpl01HNFZM7Q8FXASZXYZ6XM3TQRR&page_size=10&logged_at__gte=2024-04-17T09%3A39%3A45.984584Z&logged_at__lte=2024-04-17T09%3A39%3A45.984584Z&expand=evse' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'EvEnergy-Version: 2'

Responses

List all command logs for a specific EVSE, sorted newest first.

Headers
EvEnergy-Versionnumber

Indicates the version of the API that generated this response. If EvEnergy-Version was not specified in the request, this will be your OAuth application's default version.

Value:2
X-RateLimit-Limitnumber

The maximum number of requests that can be made to this endpoint per hour. Defaults to 1000 but may vary per client.

Default:1000
X-RateLimit-Remainingnumber

The number of requests remaining until this client's rate limit is reached.

Default:999
RetryAfternumber

The number of seconds until this client's requests will not be rate limited.

Default:3600
Bodyapplication/json
Array [
urlstring, (uri)read-only
Example:"https://api.ev.energy/v2/evses/evse01HSH04KDEWF6Z4DB2J77J74K5/command_logs/2024-04-17T09:39:45.984584Z/"
logged_atstring, (date-time)read-only

The date and time when this command was logged by the ev.energy system.

evsestring or EVSE (object)
One of:
string (uri)
max_load_target_milliampsinteger or nullread-only

The target maximum load sent to the EVSE, in milliamps.

Example:32000
is_enabled_targetboolean or nullread-only

The target state sent for is_enabled (i.e. free-vend mode).

Example:true
always_enabledboolean or nullread-only

Whether the EVSE should always be in is_enabled (i.e. free-vend) mode.

Example:false
reasonstring or nullread-only

The reason the command was sent to the EVSE.

Enum:"SCHEDULED_CHARGING""REFRESH_SCHEDULES""STOP_CHARGE""START_CHARGE""SOLAR_CHARGE_NIGHTTIME_CHARGE_RATE""API_TRIGGERED_COMMAND""COMMISSIONING""CHARGING_SESSION""VEHICLE_TO_HOME""FREE_VEND"
Example:"SCHEDULED_CHARGING"
internal_command_idstring or null, (uuid)read-only

Internal UUID to track this command dispatch. This links with device command logs.

Example:"d4e5f6a7-b8c9-0123-def0-123456789abc"
]
Response
[
  {
    "url": "https://api.ev.energy/v2/evses/evse01HSH04KDEWF6Z4DB2J77J74K5/command_logs/2024-04-17T09:39:45.984584Z/",
    "logged_at": "2019-08-24T14:15:22Z",
    "evse": "https://api.ev.energy/v2/evses/evse01HSH04KDEWF6Z4DB2J77J74K5",
    "max_load_target_milliamps": 32000,
    "is_enabled_target": true,
    "always_enabled": false,
    "reason": "SCHEDULED_CHARGING",
    "internal_command_id": "d4e5f6a7-b8c9-0123-def0-123456789abc"
  }
]