Projects

List the forecast consumption energy datums for a project

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

get

/energy/datums/consumption/predicted/projects/{projectId}

Authorizations

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 · enum

The aggregation to group the datums by

Options: year, month, day, hour, 15minute, 5minute

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.ecosuite.io//energy/datums/consumption/predicted/projects/{projectId}?start=2025-02-24T00%3A02%3A13.797Z&end=2025-02-24T00%3A02%3A13.797Z' \
  --header 'Authorization: YOUR_API_KEY'

200

400

200

{
  "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-02-24T00:02:13.797Z",
    "localEndDate": "2025-02-24T00:02:13.797Z"
  },
  "aggregation": "year"
}

successful operation