Skip to main content
GET
/
operator
/
aggregated
/
energy
Aggregated energy data
curl --request GET \
  --url https://api.telluspower.example.com/v1/operator/aggregated/energy \
  --header 'Authorization: Bearer <token>'
{
  "code": 123,
  "message": "<string>",
  "data": {
    "start_time": "2023-11-07T05:31:56Z",
    "end_time": "2023-11-07T05:31:56Z",
    "series": [
      {
        "time": "<string>",
        "charge_energy": 123,
        "discharge_energy": 123,
        "max_power": 123,
        "avg_power": 123
      }
    ],
    "total": {
      "charge_energy": 123,
      "discharge_energy": 123,
      "max_power": 123
    }
  }
}

Authorizations

​
Authorization
string
header
required

OAuth2 client-credentials grant for operator-side integrations. Obtain an access token by POSTing client_id and client_secret to /v1/operator/oauth/token. Tokens are valid for 24 hours (86,400 seconds).

Query Parameters

​
granularity
enum<string>
required
Available options:
hour,
day,
month
​
start_time
string<date-time>
required
​
end_time
string<date-time>
required
​
group_by
enum<string>
Available options:
site,
operator
​
site_ids
string

Comma-separated site IDs to filter to.

Response

200 - application/json

Aggregated series returned.

Standard response envelope. code is 0 on success and a non-zero application code on error (see Error Codes — §14).

​
code
integer
required

0 = success; otherwise an error code per the Error Codes section.

​
message
string
required

Human-readable description.

​
data
object

Endpoint-specific payload.