Projects

List the consumption energy datums for a project

get

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

HTTPcURLJavaScriptPython

GET /energy/datums/consumption/projects/{projectId}?start=2025-12-27T19%3A01%3A21.659Z&end=2025-12-27T19%3A01%3A21.659Z HTTP/1.1
Host: api.ecosuite.io/
Authorization: YOUR_API_KEY
Accept: */*

{
  "projectDatums": {
    "aggregatedTotals": {
      "ANY_ADDITIONAL_PROPERTY": {
        "consumption": 1,
        "consumptionReading": 1,
        "consumptionMax": 1,
        "consumptionMin": 1,
        "powerFactor": 1,
        "powerFactorMax": 1,
        "powerFactorMin": 1
      }
    },
    "sites": {
      "ANY_ADDITIONAL_PROPERTY": {
        "aggregatedTotals": {
          "ANY_ADDITIONAL_PROPERTY": {
            "consumption": 1,
            "consumptionReading": 1,
            "consumptionMax": 1,
            "consumptionMin": 1,
            "powerFactor": 1,
            "powerFactorMax": 1,
            "powerFactorMin": 1
          }
        },
        "systems": {
          "ANY_ADDITIONAL_PROPERTY": {
            "aggregatedTotals": {
              "ANY_ADDITIONAL_PROPERTY": {
                "consumption": 1,
                "consumptionReading": 1,
                "consumptionMax": 1,
                "consumptionMin": 1,
                "powerFactor": 1,
                "powerFactorMax": 1,
                "powerFactorMin": 1
              }
            }
          }
        }
      }
    }
  },
  "range": {
    "localStartDate": "2025-12-27T19:01:21.659Z",
    "localEndDate": "2025-12-27T19:01:21.659Z"
  },
  "aggregation": "year"
}