Get workspace consumption

GET 
/workspaces/:workspace_id/consumption

This endpoint returns the consumption data for the entire workspace.

Request

Path Parameters

workspace_id stringrequired

Workspace 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

assets

object[]

Assets of the workspace

Array [

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

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

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

status stringrequired

Status of the asset

]

carbon_footprint double

Carbon footprint of the factory

consumption double

Total consumption in kWh for the workspace

cost double

Total energy cost for the workspace

d_carbon_footprint double

Carbon footprint change of the factory

d_consumption double

Total consumption in kWh for the workspace in the previous period

d_cost double

Total energy cost for the workspace in the previous period

h_consumption

object[]

Historical total consumption in kWh for the workspace

Array [

production_machine doublerequired

Value of the production machine assets

service_machine doublerequired

Value of the service machine assets

ts stringrequired

Date of the data

]

h_cost

object[]

Historical total energy cost for the workspace

Array [

ts stringrequired

Date of the data

value doublerequired

Value of the data

]

h_power

object[]

Historical max power draw in kW for the workspace

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

]

power double

Power consumption in kW for the workspace

type_contributions

object[]

Type contributions to the total consumption

Array [

key stringrequired

Key of the data

value doublerequired

Value of the data

]

Example (from schema)

{
  "assets": [
    {
      "alarm": true,
      "asset_type": "string",
      "carbon_footprint": 0,
      "consumption": 0,
      "cost": 0,
      "d_carbon_footprint": 0,
      "d_consumption": 0,
      "d_cost": 0,
      "d_power_avg": 0,
      "id": "string",
      "last_data_ts": "string",
      "name": "string",
      "power_avg": 0,
      "status": "string"
    }
  ],
  "carbon_footprint": 0,
  "consumption": 0,
  "cost": 0,
  "d_carbon_footprint": 0,
  "d_consumption": 0,
  "d_cost": 0,
  "h_consumption": [
    {
      "production_machine": 0,
      "service_machine": 0,
      "ts": "string"
    }
  ],
  "h_cost": [
    {
      "ts": "string",
      "value": 0
    }
  ],
  "h_power": [
    {
      "power_avg": 0,
      "power_max": 0,
      "power_min": 0,
      "ts": "string"
    }
  ],
  "power": 0,
  "type_contributions": [
    {
      "key": "string",
      "value": 0
    }
  ]
}

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...