Knaq API v1

GET /1/equipment-statistics/reports

Returns report of an equipment collection within a specified date range.

Endpoint URL

https://api.knaq.io/1/equipment-statistics/reports

Authentication

Authorization request header Bearer token

Query parameters

Name Type Description
start_date string Required. This date is inclusive. The value provided is in the format "yyyy-mm-dd", indicating a specific year, month, and day.
end_date string Required. This date is inclusive. The value provided is in the format "yyyy-mm-dd", indicating a specific year, month, and day.
building string Require at least one of building and department to be set.
department string Require at least one of building and department to be set.

Example responses 

{
  "reports": [
    {
      "device_id":"00010001-0001-0001-0001-000100010001",
      "building": "123 Main Street",
      "equipment_name": "PE 1",
      "equipment_type": "hydraulic",
      "start_date": "2023-04-03",
      "end_date": "2023-04-09",
      "record_count": 7,
      "scheduled_runtime": 168.0,
      "gross_uptime": 0.90122,
      "net_uptime": 0.98675,
      "gross_downtime": 16.594,
      "planned_downtime": 14.369,
      "unplanned_downtime": 2.226,
      "unplanned_downtime_mechanical": 2.226,
      "unplanned_downtime_misuse": 0.0,
      "unplanned_downtime_vandalism": 0.0,
      "unplanned_downtime_environmental": 0.0,
      "unplanned_downtime_power": 0.0,
      "unplanned_downtime_accident": 0.0,
      "unplanned_downtime_uncategorized": 0.0,
      "utilization": 0.03531
    }
  ]
}
{
  "error": {
    "code": "InvalidRequestQueryParameters",
    "message": ""
  }
}

Response fields

Name Type Description
device_id string Unique identifier of this equipment.
building string The building or equipment location.
equipment_name string The name or label assigned to this equipment.
equipment_type string The type or category of this equipment.

Supported values:
  • hydraulic
  • traction
  • escalator
  • moving_walkway
  • HVAC
  • compressor
start_date date The first date of record available within the query period. This date is inclusive. The value provided is in the format "yyyy-mm-dd," indicating a specific year, month, and day.
end_date date The last date of record available within the query period. This date is inclusive. The value provided is in the format "yyyy-mm-dd," indicating a specific year, month, and day.
record_count integer Number of daily records within the query period.
scheduled_runtime number The total expected or planned runtime of the equipment during the query period.
gross_uptime number Percentage of time in which the equipment was operational.
net_uptime number Percentage of time in which the equipment was operational or under planned maintenance.
gross_downtime number The total downtime when the equipment was not operational during the query period.
planned_downtime number The total planned or scheduled downtime when the equipment was under planned maintenance during the query period.
unplanned_downtime number The total downtime when the equipment was non-operational and not in planned maintenance during the query period.
unplanned_downtime_mechanical number The unplanned downtime related to mechanical issues.
unplanned_downtime_misuse number The unplanned downtime related to misuse or improper use of the equipment.
unplanned_downtime_vandalism number The unplanned downtime related to vandalism or intentional damage to the equipment.
unplanned_downtime_environmental number The unplanned downtime related to environmental factors.
unplanned_downtime_power number The unplanned downtime related to power issues.
unplanned_downtime_accident number The unplanned downtime related to accidents.
unplanned_downtime_uncategorized number The unplanned downtime that does not fit into any predefined categories.
utilization number Equipment runtime as a percentage of total time.
Jump to