Projects

List the energy datums for a project

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

get

/energy/datums/projects/{projectId}

Authorizations

Path parameters

projectIdstringrequired

The ID of the project

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/projects/{projectId}?start=2025-02-23T22%3A37%3A12.365Z&end=2025-02-23T22%3A37%3A12.365Z' \
  --header 'Authorization: YOUR_API_KEY'

200

400

200

{
  "projectDatums": {
    "code": "text",
    "name": "text",
    "peakConsumption": 1,
    "peakGeneration": 1,
    "aggregatedTotals": [
      {
        "ANY_ADDITIONAL_PROPERTY": {
          "generation": 1,
          "generationReading": 1,
          "normalisedGeneration": 1,
          "consumption": 1,
          "consumptionReading": 1,
          "export": 1,
          "exportReading": 1,
          "storage": 1,
          "storageReading": 1,
          "forecast48Consumption": 1,
          "forecast12Consumption": 1,
          "forecast24Consumption": 1,
          "forecastConsumption": 1
        }
      }
    ],
    "sources": [
      {
        "ANY_ADDITIONAL_PROPERTY": {
          "reading": 1,
          "peakReading": 1
        }
      }
    ],
    "sites": {
      "ANY_ADDITIONAL_PROPERTY": {
        "code": "text",
        "name": "text",
        "peakConsumption": 1,
        "peakGeneration": 1,
        "aggregatedTotals": [
          {
            "ANY_ADDITIONAL_PROPERTY": {
              "generation": 1,
              "generationReading": 1,
              "normalisedGeneration": 1,
              "consumption": 1,
              "consumptionReading": 1,
              "export": 1,
              "exportReading": 1,
              "storage": 1,
              "storageReading": 1,
              "forecast48Consumption": 1,
              "forecast12Consumption": 1,
              "forecast24Consumption": 1,
              "forecastConsumption": 1
            }
          }
        ],
        "sources": [
          {
            "ANY_ADDITIONAL_PROPERTY": {
              "reading": 1,
              "peakReading": 1
            }
          }
        ],
        "systems": {
          "ANY_ADDITIONAL_PROPERTY": {
            "code": "text",
            "name": "text",
            "peakConsumption": 1,
            "peakGeneration": 1,
            "aggregatedTotals": [
              {
                "ANY_ADDITIONAL_PROPERTY": {
                  "generation": 1,
                  "generationReading": 1,
                  "normalisedGeneration": 1,
                  "consumption": 1,
                  "consumptionReading": 1,
                  "export": 1,
                  "exportReading": 1,
                  "storage": 1,
                  "storageReading": 1,
                  "forecast48Consumption": 1,
                  "forecast12Consumption": 1,
                  "forecast24Consumption": 1,
                  "forecastConsumption": 1
                }
              }
            ],
            "sources": [
              {
                "ANY_ADDITIONAL_PROPERTY": {
                  "reading": 1,
                  "peakReading": 1
                }
              }
            ]
          }
        }
      }
    }
  },
  "range": {
    "localStartDate": "2025-02-23T22:37:12.365Z",
    "localEndDate": "2025-02-23T22:37:12.365Z"
  },
  "aggregation": "year"
}

successful operation