Get workspace productivity

GET 
/workspaces/:workspace_id/productivity

This endpoint returns the productivity data for the workspace.

Request

Path Parameters

workspace_id stringrequired

Workspace ID

Query Parameters

start date-timerequired

Start date of the data

end date-timerequired

End date of the data

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

availability doublerequired

Availability percentage of the asset

avg_cycle_time doublerequired

Average cycle time of the asset in seconds

bad_items int64required

Total bad items produced by the asset

good_items int64required

Total good items produced by the asset

id stringrequired

ID of the asset

last_data_ts string

Last data timestamp

missing_ideal_cycle_time booleanrequired

True if the asset is missing ideal cycle time for one or more operations

name stringrequired

Name of the asset

oee doublerequired

OEE percentage of the asset

performance doublerequired

Performance percentage of the asset

quality doublerequired

Quality percentage of the asset

status stringrequired

Status of the asset

total_items int64required

Total items produced by the asset

]

availability double

Availability percentage of the workspace

h_items

object[]

Historical items produced for the workspace

Array [

bad int64required

Bad items produced

good int64required

Good items produced

ts stringrequired

Date of the data

]

h_oee

object[]

Historical OEE for the workspace

Array [

ts stringrequired

Date of the data

value doublerequired

Value of the data

]

oee double

OEE percentage of the workspace

performance double

Performance percentage of the workspace

quality double

Quality percentage of the workspace

Example (from schema)

{
  "assets": [
    {
      "alarm": true,
      "asset_type": "string",
      "availability": 0,
      "avg_cycle_time": 0,
      "bad_items": 0,
      "good_items": 0,
      "id": "string",
      "last_data_ts": "string",
      "missing_ideal_cycle_time": true,
      "name": "string",
      "oee": 0,
      "performance": 0,
      "quality": 0,
      "status": "string",
      "total_items": 0
    }
  ],
  "availability": 0,
  "h_items": [
    {
      "bad": 0,
      "good": 0,
      "ts": "string"
    }
  ],
  "h_oee": [
    {
      "ts": "string",
      "value": 0
    }
  ],
  "oee": 0,
  "performance": 0,
  "quality": 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...