Datums

List the energy datums for all projects

get

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

Authorizations

ecogy-auth-cognito-dev

AuthorizationstringRequired

Query parameters

projectIdsstringOptional

Optional list of comma separated projectIds to restrict the response to

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

HTTPcURLJavaScriptPython

GET /energy/datums?start=2025-12-13T20%3A22%3A42.342Z&end=2025-12-13T20%3A22%3A42.342Z HTTP/1.1
Host: api.ecosuite.io/
Authorization: YOUR_API_KEY
Accept: */*

{
  "projects": {
    "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
          }
        }
      ],
      "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-12-13T20:22:42.342Z",
    "localEndDate": "2025-12-13T20:22:42.342Z"
  },
  "aggregation": "year"
}