Get a timeline of utilization crossed with maintenance events information.

GET /api/filters/maintenance_timeline

Get a timeline of bucketed utilization data, along with information on timely and late filter maintenance, utilization hours in overuse, and others.

Query parameters

filter string

criteria to filter by
start string Required

ISO8601 encoded datetime from when to start querying data
interval number Required

duration of the intervals to return, in days
timezone string

Time zone in which to request the buckets
end string Required

ISO8601 encoded datetime until when to query data

Responses

200 application/json

OK
Hide response attribute Show response attribute object
- data array[object]
  
  Filter Utilization data
  
  Utilization of a booth for a time bucket, broken down by healthy vs overused
  
  Hide data attributes Show data attributes object
  
  account_id string
  
  ID of the account the booth belongs to
  
  booth_id string
  
  ID of the booth in the system
  
  cycle_count number
  
  Total number of cycles that were completed in the time bucket, including overuse ones
  
  duration number
  
  Duration of the time bucket in days
  
  events_during_period array[object]
  
  Events during a given period
  
  Hide events_during_period attributes Show events_during_period attributes object
  
  active_spray_time number
  
  Total active spray time the booth had when the filter was in place
  
  booth_in_use_time number
  
  Total in-use time of the booth when the filter was in place
  
  booth_overuse_cycles number
  
  Total number of cycles that were completed while the filter was in overuse
  
  booth_overuse_time number
  
  Total time in-use that was spent while a filter was in overuse
  
  duration number
  
  Number of days the filter was on the booth
  
  filter_type string
  
  Type of the filter. One of intake_filter | pre_filter | exhaust_filter
  
  maintenance_date string
  
  ISO8601 encoded date for when the filter was removed from the booth
  
  overuse number
  
  Total number of days the booth spent in overuse
  
  facility_id string
  
  ID of the facility the booth belongs to
  
  in_use number
  
  Number of minutes in the time bucket that the booth was in use
  
  late_maintenance_events number
  
  Number of late maintenance events that were performed during the time bucket
  
  on_time_maintenance_events number
  
  Number of maintenance events performed in time during the time bucket
  
  overuse_cycle_count number
  
  Number of cycles that were completed in the time bucket with one or more filters in overuse
  
  overuse_time number
  
  Number of minutes in the time bucket that the booth was in use while a filter was in overuse
  
  region_id string
  
  ID of the region the booth belongs to
  
  start string
  
  ISO8601 encoded timestamp marking the start of the time bucket
400 application/json

Bad Request
Hide response attribute Show response attribute object
- error string
  
  Human readable version of the error status code
401 application/json

Unauthorized
Hide response attribute Show response attribute object
- error string
  
  Human readable version of the error status code

GET /api/filters/maintenance_timeline

curl \
 --request GET 'http://localhost:4000/api/filters/maintenance_timeline?start=string&interval=42.0&end=string' \
 --header "Authorization: $API_KEY"

Response examples (200)

{
  "data": [
    {
      "account_id": "string",
      "booth_id": "string",
      "cycle_count": 42.0,
      "duration": 42.0,
      "events_during_period": [
        {
          "active_spray_time": 42.0,
          "booth_in_use_time": 42.0,
          "booth_overuse_cycles": 42.0,
          "booth_overuse_time": 42.0,
          "duration": 42.0,
          "filter_type": "string",
          "maintenance_date": "string",
          "overuse": 42.0
        }
      ],
      "facility_id": "string",
      "in_use": 42.0,
      "late_maintenance_events": 42.0,
      "on_time_maintenance_events": 42.0,
      "overuse_cycle_count": 42.0,
      "overuse_time": 42.0,
      "region_id": "string",
      "start": "string"
    }
  ]
}

Response examples (400)

{
  "error": "Error Reason"
}

Response examples (400)

{
  "error": "Error Reason"
}

Response examples (401)

{
  "error": "Error Reason"
}

Response examples (401)

{
  "error": "Error Reason"
}