Forward Events

Forward Event Data of Devices

Make sure that event data, which shall be taken into consideration by MOOST Recommender Platform, are forwarded to MOOST via MOOST API.

See Event Types to get an overview which Events should be forwarded for which Devices in which periodicity.

Add an Event

For sending new Events to the MOOST Recommender Platform the below Endpoint can be used.

Add an event to a building

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

Authorization

bearerAuth

Body

application/json

timestampinteger (int64)

customerId*string

Pattern: ^[a-zA-Z0-9]{24}$

customerBuildingId*string

Pattern: ^[a-zA-Z0-9:._-]{1,100}$

deviceId*string

Pattern: ^[a-zA-Z0-9:._-]{3,64}$

deviceName*string

Pattern: ^.{1,100}$

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_YESTERDAYENERGY_EXPORTENERGY_EXPORT_YESTERDAYEXPECTED_OUTSIDE_TEMPERATUREEXPECTED_OUTSIDE_TEMPERATURE_4DAYSGRID_POWER_CONSUMPTIONGRID_POWER_CONSUMPTION_ANOMALY_SCOREIS_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_STATETEMPERATUREWATER_TEMPERATUREPOWER_CONSUMPTION_BASE_LOADDYNAMIC_TARIFF_PRICE

sourceenum

APPLIANCEBATTERYCARCAR_CHARGERENERGY_MEASUREMENTGATEWAYHEAT_PUMPINPUT_DEVICEINVERTERMOOSTSMART_METERSMART_PLUGSWITCHTHERMOSTATTHERMAL_ZONETHERMAL_STORAGEWATER_HEATERWALL_TABLET

forecastTimestampinteger (int64)

ingestionTimestampinteger (int64)

Response

201400

Created

Request

JavaScriptCurlPython

const response = await fetch('https://api.moost.io/events/v1', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "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();

Example with CURL

# make sure ACCESS_TOKEN is set and valid (see "Request Access Token")
curl -X POST "https://api.moost.io/events/v1" \
     -H  "Authorization: Bearer $ACCESS_TOKEN" \
     -H  "Content-Type: application/json" \
     -d "{\"timestamp\":1657029000,\"customerId\":\"656730be2bc9719e6e5ed51d\",\"customerBuildingId\":\"999000009C54AAAA\",\"deviceId\":\"17306deb97e0f94609f13e22\",\"deviceName\":\"Device Link Car\",\"value\":99.9,\"type\":\"STATE_OF_CHARGE_RATE\",\"source\":\"CAR\"}"