Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: https and not http

Description

Returns an overview of the appliance events reported on a specific service location. It is possible to filter on one or more appliances.

Resource URL

https://app1pub.smappee.net/dev/v1/servicelocation/[SERVICELOCATIONID]/events

HTTP method

GET

HTTP header

Authorization: Bearer [ACCESS_TOKEN]

(info) [ACCESS_TOKEN] being the access token received from the Get token or Refresh token authentication calls.

Parameters

ParameterTypeDescription
SERVICELOCATIONIDPath ParameterThe actual id of an accessible service location (see Get Servicelocations)
applianceIdQuery ParameterThis parameter can be repeated and refers to an appliance id as described in the service location info (see Get Servicelocation Info)
fromQuery ParameterThe UTC timestamp in milliseconds indicating the beginning of the requested period
toQuery ParameterThe UTC timestamp in milliseconds indicating the end of the requested period
maxNumberQuery ParameterThe maximum number of events that should be returned by this query

Example

httphttps://app1pub.smappee.net/dev/v1/servicelocation/123/events?applianceId=1&applianceId=2&applianceId=3&applianceId=4&maxNumber=100&from=1388534400000&to=1391212800000

Result

Code Block
languagepy
[
  {activePower: 340, totalPower: 1060, applianceId: 432, timestamp: 1391212532100},
  {activePower: -120, totalPower: 720, applianceId: 472, timestamp: 1389215612400}, 
  ... 
]


FieldDescription
activePowerPower value (Watt) as a result of the appliance event. Positive value in case the appliance is switched on, negative value in case the appliance is switched off.
totalPowerTotal power (Watt) after the event.
applianceIdID of the appliance.
timestampUTC timestamp in milliseconds. Events are ordered descending.


Page Properties
hiddentrue
idrest-api-method


Index4
Resource URLhttps://app1pub.smappee.net/dev/v1/servicelocation/[SERVICELOCATIONID]/events
HTTP methodGET
Description

Returns an overview of the appliance events reported on a specic service location. It is possible to filter on one or more appliances.




Panel
titleContent

Table of Contents