Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

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

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

Result

[
  {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.
Content

  • No labels