Sign in

Monthly utility cost, energy and carbon by resource

Aggregates emission rows classified with the given usage (default building) by calendar month of start_time and utility resource. Costs are split into energy cost (carbon rows) and other charges (standing charges, levies) per currency. Rows of soft-deleted source records are excluded. At most 120 months.

post/utility/series

Request body

endMonthstring required
startMonthstring required
usage'building' | 'vehicle'

Which utility rows to aggregate (building energy and water, or vehicle fuel).

Example request

{
  "endMonth": "2025-12",
  "startMonth": "2025-01"
}

Response

Utility series

Example response

{
  "data": {
    "endMonth": "2025-12",
    "rows": [
      {
        "month": "2025-01"
      }
    ],
    "startMonth": "2025-01"
  }
}

Changes

Changed in 1 of the 5 revisions of this API.1