Projects

List the forecast consumption energy datums for a project

get

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

Authorizations

ecogy-auth-cognito-dev

AuthorizationstringRequired

Path parameters

projectIdstringRequired

The ID of the project to get the datums for

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/projects/{projectId}

HTTPcURLJavaScriptPython

GET /energy/datums/consumption/predicted/projects/{projectId}?start=2025-12-27T20%3A40%3A44.307Z&end=2025-12-27T20%3A40%3A44.307Z HTTP/1.1
Host: api.ecosuite.io/
Authorization: YOUR_API_KEY
Accept: */*

{
  "projectDatums": {
    "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-27T20:40:44.307Z",
    "localEndDate": "2025-12-27T20:40:44.307Z"
  },
  "aggregation": "year"
}