Get machine consumption

GET 
/workspaces/:workspace_id/consumption/assets/:resource_id

This endpoint returns the consumption data for a single machine.

Request

Path Parameters

workspace_id stringrequired

Workspace ID

resource_id stringrequired

Asset ID

Query Parameters

start date-timerequired

Start date of the data range

end date-timerequired

End date of the data range

s string

Shift ID

Responses

200

OK response.

application/json

Schema

Schema

alarm booleanrequired

Alarm status of the asset

asset_type stringrequired

Type of the asset

carbon_footprint double

Carbon footprint of the machine

consumption double

Total consumption in kWh for the asset

cost double

Total energy cost for the asset

current_power double

Average power consumption in kW for the asset

d_carbon_footprint double

Carbon footprint change of the machine

d_consumption double

Percentage change of the total consumption in kWh for the asset in the previous period

d_cost double

Percentage change of the total cost for the asset in the previous period

d_power_avg double

Percentage change of the average power consumption in kW for the asset in the previous period

d_power_max double

Percentage change of the max power consumption in kW for the asset in the previous period

d_power_min double

Percentage change of the min power consumption in kW for the asset in the previous period

h_alarm

object[]

Historical alarm status of the asset

Array [

alarm doublerequired

Value of the alarm data

ts stringrequired

Date of the data

]

h_consumption

object[]

Historical total consumption in kWh for the asset

Array [

ts stringrequired

Date of the data

value doublerequired

Value of the data

]

h_cost

object[]

Historical total energy cost for the asset

Array [

ts stringrequired

Date of the data

value doublerequired

Value of the data

]

h_power

object[]

Historical max power draw in kW for the asset

Array [

power_avg doublerequired

Average Power consumption in kW for the asset

power_max doublerequired

Max power consumption in kW for the asset

power_min doublerequired

Min power consumption in kW for the asset

ts stringrequired

Timestamp of the data

]

h_status

object[]

Historical status of the asset

Array [

idle doublerequired

Value of the idle data

offline doublerequired

Value of the offline data

ts stringrequired

Date of the data

working doublerequired

Value of the working data

]

id stringrequired

ID of the asset

last_data_ts string

Last data timestamp

name stringrequired

Name of the asset

power_avg double

Average power consumption in kW for the asset

power_max double

Max power consumption in kW for the asset

power_min double

Min power consumption in kW for the asset

state_contributions

object[]

State contributions to the total consumption

Array [

key stringrequired

Key of the data

value doublerequired

Value of the data

]

status stringrequired

Status of the asset

Example (from schema)

{
  "alarm": true,
  "asset_type": "string",
  "carbon_footprint": 0,
  "consumption": 0,
  "cost": 0,
  "current_power": 0,
  "d_carbon_footprint": 0,
  "d_consumption": 0,
  "d_cost": 0,
  "d_power_avg": 0,
  "d_power_max": 0,
  "d_power_min": 0,
  "h_alarm": [
    {
      "alarm": 0,
      "ts": "string"
    }
  ],
  "h_consumption": [
    {
      "ts": "string",
      "value": 0
    }
  ],
  "h_cost": [
    {
      "ts": "string",
      "value": 0
    }
  ],
  "h_power": [
    {
      "power_avg": 0,
      "power_max": 0,
      "power_min": 0,
      "ts": "string"
    }
  ],
  "h_status": [
    {
      "idle": 0,
      "offline": 0,
      "ts": "string",
      "working": 0
    }
  ],
  "id": "string",
  "last_data_ts": "string",
  "name": "string",
  "power_avg": 0,
  "power_max": 0,
  "power_min": 0,
  "state_contributions": [
    {
      "key": "string",
      "value": 0
    }
  ],
  "status": "string"
}

400

bad_request: Invalid request

application/json

Schema

Schema

message stringrequired

Message of error

Example (from schema)

{
  "message": "invalid request"
}

500

internal_error: Internal server error

application/json

Schema

Schema

message stringrequired

Message of error

Example (from schema)

{
  "message": "invalid request"
}

Loading...