Get the historic log of filter maintenances for all booths in scope.

GET /api/filters/maintenance_history

Api key

Allows you to retrieve the full log of past filter maintenances that have happened on booths that are in scope.

Query parameters

filter string

criteria to filter by
sort string

criteria to sort by
limit string

amount of results per page to return
page string

page number
start string

ISO8601 formatted datetime to include maintenances since
format string

format in which to receive the data

Values are csv or json.
end string

ISO8601 formated datetime to include maintenances until

Responses

200 application/json

OK
Hide response attribute Show response attribute object
- data array[object]
  
  List of past filter maintenances for a booth
  
  Hide data attributes Show data 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
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_history

curl \
 --request GET 'http://localhost:4000/api/filters/maintenance_history' \
 --header "Authorization: $API_KEY"

Response examples (200)

{
  "data": [
    {
      "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
    }
  ]
}

Response examples (401)

{
  "error": "Error Reason"
}

Response examples (401)

{
  "error": "Error Reason"
}