v1

latestOpenAPI 3.0.12026-07-243686491.1 MB

Charge Point Statistics

Retrieve statistics related to a site

Required scope: charge-points:read

get/api/v1/charge-point-statistics/by-site

Query parameters

siteIdinteger required

Filter to retrieve statistics for a given site by siteId

Example:45

fromDatestring date required

Filter to retrieve charge point statistics created from date (YYYY-MM-DD), we expect a date in UTC</br>The maximum gap between from and to data cannot be longer than 365 days

Example:2022-05-01

toDatestring date required

Filter to retrieve charge point statistics created to date (YYYY-MM-DD), we expect a date in UTC</br>The maximum gap between from and to data cannot be longer than 365 days

Example:2022-05-30

Response

Statistics that match the provided criteria

siteIdinteger nullable

Id of the site

fromDatestring date-time required

Start date of the statistics period

toDatestring date-time required

End date of the statistics period

totalEnergyConsumednumber required

Total energy consumed during the period (in kWh)

totalSessionsinteger required

Total number of charging sessions during the period

sessionSuccessRatenumber double required

Success rate of charging sessions during the period (as a percentage)

systemUptimePercentagenumber double nullable

Percentage of uptime for the system during the period

Example response

{
  "siteId": 42,
  "fromDate": "2024-03-20T00:00:00Z",
  "toDate": "2024-03-30T00:00:00Z",
  "totalEnergyConsumed": 500.5,
  "totalSessions": 150,
  "sessionSuccessRate": 95,
  "systemUptimePercentage": 99.9,
  "states": [
    {
      "state": "operational",
      "percentage": 75,
      "duration": 3600
    }
  ],
  "days": [
    {
      "date": "2024-03-30T00:00:00Z",
      "dailyPerformance": [
        {
          "status": "operational",
          "duration": 3600,
          "usagePercentage": 75
        }
      ]
    }
  ],
  "months": [
    {
      "date": "2024-03-30T00:00:00Z",
      "dailyPerformance": [
        {
          "status": "operational",
          "duration": 3600,
          "usagePercentage": 75
        }
      ]
    }
  ]
}