Dashboard summary
curl --request POST \
--url https://api.example.com/dashboard/summary \
--header 'Content-Type: application/json' \
--data '
{
"from": "2023-11-07T05:31:56Z",
"to": "2023-11-07T05:31:56Z",
"groupId": 123,
"stationId": 123,
"utcOffsetMinutes": 0,
"byStation": true
}
'import requests
url = "https://api.example.com/dashboard/summary"
payload = {
"from": "2023-11-07T05:31:56Z",
"to": "2023-11-07T05:31:56Z",
"groupId": 123,
"stationId": 123,
"utcOffsetMinutes": 0,
"byStation": True
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
from: '2023-11-07T05:31:56Z',
to: '2023-11-07T05:31:56Z',
groupId: 123,
stationId: 123,
utcOffsetMinutes: 0,
byStation: true
})
};
fetch('https://api.example.com/dashboard/summary', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/dashboard/summary",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'from' => '2023-11-07T05:31:56Z',
'to' => '2023-11-07T05:31:56Z',
'groupId' => 123,
'stationId' => 123,
'utcOffsetMinutes' => 0,
'byStation' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/dashboard/summary"
payload := strings.NewReader("{\n \"from\": \"2023-11-07T05:31:56Z\",\n \"to\": \"2023-11-07T05:31:56Z\",\n \"groupId\": 123,\n \"stationId\": 123,\n \"utcOffsetMinutes\": 0,\n \"byStation\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/dashboard/summary")
.header("Content-Type", "application/json")
.body("{\n \"from\": \"2023-11-07T05:31:56Z\",\n \"to\": \"2023-11-07T05:31:56Z\",\n \"groupId\": 123,\n \"stationId\": 123,\n \"utcOffsetMinutes\": 0,\n \"byStation\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/dashboard/summary")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"from\": \"2023-11-07T05:31:56Z\",\n \"to\": \"2023-11-07T05:31:56Z\",\n \"groupId\": 123,\n \"stationId\": 123,\n \"utcOffsetMinutes\": 0,\n \"byStation\": true\n}"
response = http.request(request)
puts response.read_body{
"summary": {
"period": {
"from": "2023-11-07T05:31:56Z",
"to": "2023-11-07T05:31:56Z",
"utcOffsetMinutes": 123
},
"stations": {
"total": 123,
"online": 123,
"offline": 123
},
"connectors": {
"total": 123,
"byStatus": {}
},
"sessions": {
"total": 123,
"active": 123,
"ended": 123,
"energyKwh": 123
},
"series": [
{
"bucket": "2023-11-07T05:31:56Z",
"sessions": 123,
"energyKwh": 123
}
],
"byStation": [
{
"stationId": 123,
"sessions": 123,
"energyKwh": 123
}
]
}
}{
"status": 123,
"message": "<string>",
"type": "<string>",
"attributes": {}
}{
"status": 123,
"message": "<string>",
"type": "<string>",
"attributes": {}
}dashboard
Dashboard summary
Aggregates stations, connectors, sessions and energy over a period, as a time series and optionally broken down per station.
POST
/
dashboard
/
summary
Dashboard summary
curl --request POST \
--url https://api.example.com/dashboard/summary \
--header 'Content-Type: application/json' \
--data '
{
"from": "2023-11-07T05:31:56Z",
"to": "2023-11-07T05:31:56Z",
"groupId": 123,
"stationId": 123,
"utcOffsetMinutes": 0,
"byStation": true
}
'import requests
url = "https://api.example.com/dashboard/summary"
payload = {
"from": "2023-11-07T05:31:56Z",
"to": "2023-11-07T05:31:56Z",
"groupId": 123,
"stationId": 123,
"utcOffsetMinutes": 0,
"byStation": True
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
from: '2023-11-07T05:31:56Z',
to: '2023-11-07T05:31:56Z',
groupId: 123,
stationId: 123,
utcOffsetMinutes: 0,
byStation: true
})
};
fetch('https://api.example.com/dashboard/summary', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/dashboard/summary",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'from' => '2023-11-07T05:31:56Z',
'to' => '2023-11-07T05:31:56Z',
'groupId' => 123,
'stationId' => 123,
'utcOffsetMinutes' => 0,
'byStation' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/dashboard/summary"
payload := strings.NewReader("{\n \"from\": \"2023-11-07T05:31:56Z\",\n \"to\": \"2023-11-07T05:31:56Z\",\n \"groupId\": 123,\n \"stationId\": 123,\n \"utcOffsetMinutes\": 0,\n \"byStation\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/dashboard/summary")
.header("Content-Type", "application/json")
.body("{\n \"from\": \"2023-11-07T05:31:56Z\",\n \"to\": \"2023-11-07T05:31:56Z\",\n \"groupId\": 123,\n \"stationId\": 123,\n \"utcOffsetMinutes\": 0,\n \"byStation\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/dashboard/summary")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"from\": \"2023-11-07T05:31:56Z\",\n \"to\": \"2023-11-07T05:31:56Z\",\n \"groupId\": 123,\n \"stationId\": 123,\n \"utcOffsetMinutes\": 0,\n \"byStation\": true\n}"
response = http.request(request)
puts response.read_body{
"summary": {
"period": {
"from": "2023-11-07T05:31:56Z",
"to": "2023-11-07T05:31:56Z",
"utcOffsetMinutes": 123
},
"stations": {
"total": 123,
"online": 123,
"offline": 123
},
"connectors": {
"total": 123,
"byStatus": {}
},
"sessions": {
"total": 123,
"active": 123,
"ended": 123,
"energyKwh": 123
},
"series": [
{
"bucket": "2023-11-07T05:31:56Z",
"sessions": 123,
"energyKwh": 123
}
],
"byStation": [
{
"stationId": 123,
"sessions": 123,
"energyKwh": 123
}
]
}
}{
"status": 123,
"message": "<string>",
"type": "<string>",
"attributes": {}
}{
"status": 123,
"message": "<string>",
"type": "<string>",
"attributes": {}
}Body
application/json
Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$Available options:
hour, day Required range:
-840 <= x <= 840Response
Successful response
Show child attributes
Show child attributes
⌘I