Get a timeseries of charger states for sites
x-ms-visibility: "important"
Retrieve a time series of charger states for sites.
Query Parameters
from date-time
Start timestamp for the period to be fetched. Default: 7 days ago.
to date-time
End timestamp for the period to be fetched. Default: Now.
siteIds int64[]
Array of site IDs to filter the results.
chargerIds string[]
Array of charger IDs to filter the results.
socketIds int32[]
Array of socket IDs to filter the results.
includeSubsites boolean
Set to 'true' to include subsites in the results. Default: false
page int32
Page to be fetched. Default: 1
limit int32
Limit (No. of records per page). Default: 100
sortKey string
Sort field to be used (Default: Timestamp)
sortDescending boolean
Set to 'true' to sort descending based on sort key (Default: true)
Responses
- 200
- 400
- 401
Time series of charger states.
application/json
Schema
Example (from schema)
Schema
- Array [
- ]
page int32
limit int32
totalRecords int32
hasNextPage boolean
hasPreviousPage boolean
items object[]
timestamp date-time
available int64
error int64
offline int64
info int64
charging int64
suspendedCAR int64
suspendedCharger int64
preparing int64
finishing int64
reserved int64
booting int64
unavailable int64
total int64
{
"page": 0,
"limit": 0,
"totalRecords": 0,
"hasNextPage": true,
"hasPreviousPage": true,
"items": [
{
"timestamp": "2025-05-28T10:55:51.170Z",
"available": 0,
"error": 0,
"offline": 0,
"info": 0,
"charging": 0,
"suspendedCAR": 0,
"suspendedCharger": 0,
"preparing": 0,
"finishing": 0,
"reserved": 0,
"booting": 0,
"unavailable": 0,
"total": 0
}
]
}
Invalid request parameters
application/json
Schema
Example (from schema)
Schema
errorCode string
message string
errorNumber int32
helpLink string
{
"errorCode": "string",
"message": "string",
"errorNumber": 0,
"helpLink": "string"
}
User not authorized
Loading...