map

Get all cleaning summaries

Returns the summaries of the cleaning runs which are stored on the home appliance.

Each summary contains the map data as it was at the time of the cleaning run.

get/homeappliances/{haId}/map/cleaningSummary

Request

  • Base URL: https://api.home-connect.com/api
  • URL: https://api.home-connect.com/api/homeappliances/{haId}/map/cleaningSummary
  • Auth: OAuth 2 (authorization code, authorization URL https://api.home-connect.com/security/oauth/authorize, token URL https://api.home-connect.com/security/oauth/token, scopes: CleaningRobot-Map)

Response

List of cleaning summaries

counterinteger required

Incremental counter that uniquely identifies each cleaning run summary

Example response

[
  {
    "map": {
      "mapId": 1,
      "name": "Ground floor",
      "isSaved": true,
      "baseStations": [
        {
          "x": 120,
          "y": -35,
          "angleX": 90
        }
      ]
    }
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.