GET api/customers/{customerId}/contracts/{contractNo}/meters/{meterId}/dashboard?includeCosts={includeCosts}&includeUnreadMessageCount={includeUnreadMessageCount}&includeLastMonth={includeLastMonth}&includeWattMeter={includeWattMeter}&appShortName={appShortName}&includeLightsAndHeating={includeLightsAndHeating}

Get summary information for the given meter.

Request Information

URI Parameters

Name	Description	Type	Additional information
customerId	Customer ID	integer	Required
contractNo	Customer's contract number	integer	Required
meterId	Contract's meter ID	string	Required
includeCosts	Includes the yesterday costs	boolean	Default value is False
includeUnreadMessageCount	Includes unread messages count	boolean	Default value is False
includeLastMonth	Includes last month consumptiun instead of last year/yesterday	boolean	Default value is False
includeWattMeter		boolean	Default value is False
appShortName	Short name of mobile app, e.g. smartliv or rknett.	string	Default value is
includeLightsAndHeating		boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

DashboardResponse

Name	Type	Additional information
ConsumptionYesterDay	decimal number	None.
ConsumptionDayBeforeYesterDay	decimal number	None.
ConsumptionCurrentMonth	decimal number	None.
ConsumptionCurrentMonthLastYear	decimal number	None.
ConsumptionCurrentYear	decimal number	None.
ConsumptionLastYear	decimal number	None.
ConsumptionComparedToAllNeighbours	decimal number	None.
ConsumptionBestNeighbours	decimal number	None.
RecentInvoiceSum	decimal number	None.
RecentInvoiceDate	date	None.
PreviousInvoiceSum	decimal number	None.
PreviousInvoiceDate	date	None.
TotalCostYesterday	decimal number	None.
AllUnreadMessageCount	integer	None.
ConsumptionLastMonth	decimal number	None.
WattMeterLastValue	ConsumptionTimeSerieValue	None.
FavoriteMotionSensor	DeviceResponse	None.

Response Formats

application/json, text/json

Sample:

{
  "ConsumptionYesterDay": 1.1,
  "ConsumptionDayBeforeYesterDay": 1.1,
  "ConsumptionCurrentMonth": 1.1,
  "ConsumptionCurrentMonthLastYear": 1.1,
  "ConsumptionCurrentYear": 1.1,
  "ConsumptionLastYear": 1.1,
  "ConsumptionComparedToAllNeighbours": 1.1,
  "ConsumptionBestNeighbours": 1.1,
  "RecentInvoiceSum": 1.1,
  "RecentInvoiceDate": "2025-12-24T10:52:34.9150439+00:00",
  "PreviousInvoiceSum": 1.1,
  "PreviousInvoiceDate": "2025-12-24T10:52:34.9150439+00:00",
  "TotalCostYesterday": 1.1,
  "AllUnreadMessageCount": 1,
  "ConsumptionLastMonth": 1.1,
  "WattMeterLastValue": {
    "$id": "1",
    "MaxEffectValueTime": "2025-12-24T10:52:34.9150439+00:00",
    "ValueTime": "2025-12-24T10:52:34.9150439+00:00",
    "MaxEffect": 1.1,
    "Value": 1.1,
    "TimeSeriesType": 0
  },
  "FavoriteMotionSensor": {
    "AssetId": 1,
    "Name": "sample string 2",
    "Description": "sample string 3",
    "DeviceType": 1,
    "Values": [
      {
        "$id": "2",
        "ValueCategory": 1,
        "ValueTime": "2025-12-24T10:52:34.9150439+00:00",
        "ValueSubCategory": 1,
        "Value": 1.1,
        "ValueUnit": 0
      },
      {
        "$ref": "2"
      }
    ]
  }
}

text/html

Sample:

{"ConsumptionYesterDay":1.1,"ConsumptionDayBeforeYesterDay":1.1,"ConsumptionCurrentMonth":1.1,"ConsumptionCurrentMonthLastYear":1.1,"ConsumptionCurrentYear":1.1,"ConsumptionLastYear":1.1,"ConsumptionComparedToAllNeighbours":1.1,"ConsumptionBestNeighbours":1.1,"RecentInvoiceSum":1.1,"RecentInvoiceDate":"2025-12-24T10:52:34.9150439+00:00","PreviousInvoiceSum":1.1,"PreviousInvoiceDate":"2025-12-24T10:52:34.9150439+00:00","TotalCostYesterday":1.1,"AllUnreadMessageCount":1,"ConsumptionLastMonth":1.1,"WattMeterLastValue":{"$id":"1","MaxEffectValueTime":"2025-12-24T10:52:34.9150439+00:00","ValueTime":"2025-12-24T10:52:34.9150439+00:00","MaxEffect":1.1,"Value":1.1,"TimeSeriesType":0},"FavoriteMotionSensor":{"AssetId":1,"Name":"sample string 2","Description":"sample string 3","DeviceType":1,"Values":[{"$id":"2","ValueCategory":1,"ValueTime":"2025-12-24T10:52:34.9150439+00:00","ValueSubCategory":1,"Value":1.1,"ValueUnit":0},{"$ref":"2"}]}}