Knaq API v1

GET /1/equipment-statistics/usage/:id

Returns usage summary of a single equipment by the requested ID within a specified date range.

Endpoint URL

https://api.knaq.io/1/equipment-statistics/usage/:id

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.

Note: The maximum query duration is 31 days.

Example responses 

{
  "usage": {
    "device_id":"00010001-0001-0001-0001-000100010001",
    "building": "123 Main Street",
    "equipment_name": "PE 1",
    "equipment_type": "hydraulic",
    "start_date": "2023-03-01",
    "end_date": "2023-03-31",
    "record_count": 31,
    "sum_trips": 12598,
    "avg_trips": 406.387,
    "sum_motor_starts": 6484,
    "avg_motor_starts": 209.161,
    "sum_runtime": 58.404,
    "avg_runtime": 1.884,
    "sum_door_cycles": 15122,
    "avg_door_cycles": 487.806,
    "utilization": 0.0785
  }
}
{
  "error": {
    "code": "InstanceNotFound",
    "message": "Equipment not found"
  }
}

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.
sum_trips integer The total number of trips traveled by the elevator during the query period.
This field will be null if the equipment is not an elevator.
avg_trips number The average number of trips per day for the query period.
This field will be null if the equipment is not an elevator.
sum_motor_starts integer The total number of motor starts during the specified period.
avg_motor_starts number The average number of motor starts per day for the specified period.
sum_runtime number The total runtime or operating time of the equipment in hours during the query period.
avg_runtime number The average runtime or operating time in hours per day for the query period.
sum_door_cycles integer The total number of door cycles by the equipment during the query period.
This field will be null if the equipment is not an elevator.
avg_door_cycles number The average number of door cycles per day for the query period.
This field will be null if the equipment is not an elevator.
utilization number Equipment runtime as a percentage of total time.
Jump to