Predicted

List the forecast consumption energy datums for all projects

get

List the forecast consumption energy datums for a specified date range and aggregate for all projects

Authorizations

ecogy-auth-cognito-dev

AuthorizationstringRequired

Query parameters

startstring · date-timeRequired

The inclusive start date

endstring · date-timeRequired

The exclusive end date

aggregationstring · enumOptional

The aggregation to group the datums by

Possible values:

Responses

200

successful operation

application/json

400

Invalid status value

application/json

get

/energy/datums/consumption/predicted

HTTPcURLJavaScriptPython

GET /energy/datums/consumption/predicted?start=2025-12-27T00%3A58%3A24.688Z&end=2025-12-27T00%3A58%3A24.688Z HTTP/1.1
Host: api.ecosuite.io/
Authorization: YOUR_API_KEY
Accept: */*

{
  "projects": {
    "ANY_ADDITIONAL_PROPERTY": {
      "predictedConsumption": 1,
      "historicConsumption": 1,
      "targetConsumption": 1,
      "aggregatedTotals": {
        "ANY_ADDITIONAL_PROPERTY": {
          "predictedConsumption": 1,
          "historicConsumption": 1,
          "targetConsumption": 1
        }
      },
      "sites": {
        "ANY_ADDITIONAL_PROPERTY": {
          "predictedConsumption": 1,
          "historicConsumption": 1,
          "targetConsumption": 1,
          "aggregatedTotals": {
            "ANY_ADDITIONAL_PROPERTY": {
              "predictedConsumption": 1,
              "historicConsumption": 1,
              "targetConsumption": 1
            }
          },
          "systems": {
            "ANY_ADDITIONAL_PROPERTY": {
              "predictedConsumption": 1,
              "historicConsumption": 1,
              "targetConsumption": 1,
              "sources": {
                "ANY_ADDITIONAL_PROPERTY": {
                  "predictedConsumption": 1,
                  "historicConsumption": 1,
                  "targetConsumption": 1
                }
              },
              "aggregatedTotals": {
                "ANY_ADDITIONAL_PROPERTY": {
                  "predictedConsumption": 1,
                  "historicConsumption": 1,
                  "targetConsumption": 1
                }
              }
            }
          }
        }
      }
    }
  },
  "range": {
    "localStartDate": "2025-12-27T00:58:24.688Z",
    "localEndDate": "2025-12-27T00:58:24.688Z"
  },
  "aggregation": "year"
}