Events

The Recommender Platform applies pre-defined or custom rules onto a stream of events. An event represents a state change on a sensor or actor within a building.

Example JSON

{
    "timestamp": 633308400,
    "customerId": "6149884d0aafc84cb196d4c8",
    "customerBuildingId": "000000005A37A9F2",
    "deviceId": "000000005A37A9F21000",
    "deviceName": "SM Bridge",
    "value": 1234.001,
    "type": "POWER_CONSUMPTION",
    "source": "GATEWAY",
    "unit": "WATT"
}

API

POSThttps://api.moost.io/events/v1

Query parameters

Body

application/json

timestampinteger (int64)

customerId*string

customerBuildingId*string

deviceId*string

deviceName*string

value*number (float)

type*enum

CHARGING_MODEDEVICE_STATUSENERGY_CONSUMPTIONENERGY_CONSUMPTION_LAST_24HENERGY_CONSUMPTION_YESTERDAYENERGY_EXCESS_LAST_24HENERGY_EXCESS_YESTERDAYENERGY_GENERATION_LAST_24HENERGY_GENERATION_YESTERDAYENERGY_IMPORTENERGY_IMPORT_YESTERDAYEXPECTED_OUTSIDE_TEMPERATUREEXPECTED_OUTSIDE_TEMPERATURE_4DAYSGRID_POWER_CONSUMPTIONGRID_POWER_CONSUMPTION_ANOMALY_SCOREHEAT_PUMP_MODEIS_LOW_TARIFF_HOURSPOWER_CONSUMPTIONPOWER_CONSUMPTION_FORECAST_1HPOWER_CONSUMPTION_FORECAST_24HPOWER_EXCESSPOWER_GENERATIONPOWER_GENERATION_FORECAST_1HPOWER_GENERATION_FORECAST_1H_MINPOWER_GENERATION_FORECAST_24HPOWER_GENERATION_FORECAST_48HPOWER_GENERATION_FORECAST_DAY_AFTER_TOMORROWPOWER_GENERATION_FORECAST_TOMORROWSELF_CONSUMPTION_RATESELF_CONSUMPTION_RATE_YESTERDAYSELF_SUFFICIENCY_RATESELF_SUFFICIENCY_RATE_YESTERDAYSTATE_OF_CHARGE_FORECAST_RATESTATE_OF_CHARGE_RATESWITCH_STATEWATER_TEMPERATURE

sourceenum

APPLIANCEBATTERYCARCAR_CHARGERENERGY_MEASUREMENTGATEWAYGENERATORHEAT_PUMPINPUT_DEVICEINVERTERMOOSTSMART_METERSMART_PLUGSENSORSWITCHTHERMOSTATWATER_HEATERWALL_TABLET

forecastTimestampinteger (int64)

ingestionTimestampinteger (int64)

Response

201400

Created

Request

JavaScriptCurl

const response = await fetch('https://api.moost.io/events/v1', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "customerBuildingId": "text",
      "customerId": "text",
      "deviceId": "text",
      "deviceName": "text",
      "type": "CHARGING_MODE",
      "value": 0
    }),
});
const data = await response.json();