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

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

get

HTTPcURLJavaScriptPython

GET //energy/datums/consumption/predicted 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-04-30T08:19:33.663Z",
    "localEndDate": "2025-04-30T08:19:33.663Z"
  },
  "aggregation": "year"
}