❗Please note that individual device performance data API is under development and this part of documentation can be updated significantly.
The available data on charging and performance of device is summarized in the table below
| Data | Description | Endpoint |
|---|---|---|
| Charging plan | Current charging plan for the device. Shows what are Gridio’s intentions with the device at this given data point. Always forward looking, will not show data on past charging plans. | /api/v1/businesses/{business_id}/devices/{dev_id}/charge_plan |
| Historical energy consumption | Historical time series of energy consumption data for given device id provided in Wh with given resolution (1hr / 15 min) | /api/v1/businesses/{business_id}/devices/{dev_id}/metrics |
| Smart charging performance | Daily smart charging performance for given device (percent savings, energy smart charged). | /api/v1/businesses/{business_id}/devices/{dev_id}/daily_stats |
| Parameter | Description | Example |
|---|---|---|
| business_id | In request path, the business id issued by Gridio to you | 0190820e-7ba2-720f-be48-733fbbb4bc2e |
| dev_id | Device id for device to be queried | 1623596400 |
curl -X GET <https://api.gridio.energy/api/v1/businesses/{business_id}/devices/{dev_id}/charge_plan> \\
-H "Authorization: Bearer <backend access token>"
As a response you will get a list of hourly projected charging statuses for given device. Note that the charge plan timestamps are given as RFC3338 compliant strings.
{
"data": [
{
"dev_id": 1623596400,
"charge_plan": [
{
"timestamp": "2006-01-02T15:04:05-0700"
"is_charging": true
},
// and so on
]
}
]
}
Please note that this query makes sense only when
| Parameter | Description | Example |
|---|---|---|
| business_id | In request path, the business id issued by Gridio to you | 0190820e-7ba2-720f-be48-733fbbb4bc2e |
| dev_id | Device id for device to be queried | 1623596400 |
| start | in query - start time in format YYY-MM-DDTHH:MM:SS, RFC3338 compliant string | 2024-07-01T12:00:00 |
| end | in query - end time in format YYYY-MM-DDTHH:MM:SS, RFC3338 compliant string | 2024-08-01:23:59:59 |
curl -X GET <https://api.gridio.energy/api/v1/businesses/{business_id}/devices/{dev_id}/metrics?start=>{start time}&end={end time} \\
-H "Authorization: Bearer <backend access token>"
For this query, three parameters are required
| Parameter | Description | Example |
|---|---|---|
| business_id | In request path, the business id issued by Gridio to you | 0190820e-7ba2-720f-be48-733fbbb4bc2e |
| dev_id | Device to be queried | 1623596400 |
| start | in query - start date in format YYY-MM-DD | 2024-07-01 |
| end | in query - end date in format YYYY-MM-DD | 2024-08-01 |
Query itself is a simple HTTP get. Note the start and end date parameters in query string.
curl -X GET <https://api.gridio.energy/api/v1/businesses/{business_id}/devices/{dev_id}/daily_stats?start=>{start date}&end={end date} \\
-H "Authorization: Bearer <backend access token>"
As a response you will receive the following JSON