Get a summary per filter type for the booth.

GET /api/booths/{id}/filter_maintenances

Api key

Allows you to retrieve summary information of filter usage by filter type

Path parameters

id string Required

id of the booth

Query parameters

start string

ISO8601 formatted date from when to start including filters
end string Required

ISO8601 formatted date until which filters should be included

Responses

200 application/json

OK
Hide response attribute Show response attribute object
- data object
  
  Summary information for each filter type
  
  Hide data attributes Show data attributes object
  
  exhaust_filter object
  
  Hide exhaust_filter attributes Show exhaust_filter attributes object
  
  est_annual_volume_count number
  
  The estimated number of filters to be used in a year, considering the number in the time period
  
  filter_interval_log array[object]
  
  List of filter maintenances of this type that have existed for the booth.
  
  One filter of some type with its maintenance data
  
  Hide filter_interval_log attributes Show filter_interval_log attributes object
  
  duration number
  
  Lifetime for this particular filter
  
  filter_estimated_duration number
  
  Total estimated duration of the filter
  
  filter_maintenance_duration number
  
  Number of days for the maintenance window
  
  filter_nominal_duration number
  
  Lifetime - maintenance window
  
  filter_overuse_duration number
  
  Total number of days the filter has been overused
  
  start string
  
  ISO8601 encoded date of when the filter was installed
  
  last_active_filter object
  
  One filter of some type with its maintenance data
  
  Hide last_active_filter attributes Show last_active_filter attributes object
  
  duration number
  
  Lifetime for this particular filter
  
  filter_estimated_duration number
  
  Total estimated duration of the filter
  
  filter_maintenance_duration number
  
  Number of days for the maintenance window
  
  filter_nominal_duration number
  
  Lifetime - maintenance window
  
  filter_overuse_duration number
  
  Total number of days the filter has been overused
  
  start string
  
  ISO8601 encoded date of when the filter was installed
  
  lifecycle_overuse_count number
  
  The total number of days the type of filter has been overused in the time period
  
  maintenance_count number
  
  The total number of maintenance of the type registered in a time period
  
  maintenance_interval number
  
  Number of days of the maintenance window for the active filter of this type
  
  intake_filter object
  
  Hide intake_filter attributes Show intake_filter attributes object
  
  est_annual_volume_count number
  
  The estimated number of filters to be used in a year, considering the number in the time period
  
  filter_interval_log array[object]
  
  List of filter maintenances of this type that have existed for the booth.
  
  One filter of some type with its maintenance data
  
  Hide filter_interval_log attributes Show filter_interval_log attributes object
  
  duration number
  
  Lifetime for this particular filter
  
  filter_estimated_duration number
  
  Total estimated duration of the filter
  
  filter_maintenance_duration number
  
  Number of days for the maintenance window
  
  filter_nominal_duration number
  
  Lifetime - maintenance window
  
  filter_overuse_duration number
  
  Total number of days the filter has been overused
  
  start string
  
  ISO8601 encoded date of when the filter was installed
  
  last_active_filter object
  
  One filter of some type with its maintenance data
  
  Hide last_active_filter attributes Show last_active_filter attributes object
  
  duration number
  
  Lifetime for this particular filter
  
  filter_estimated_duration number
  
  Total estimated duration of the filter
  
  filter_maintenance_duration number
  
  Number of days for the maintenance window
  
  filter_nominal_duration number
  
  Lifetime - maintenance window
  
  filter_overuse_duration number
  
  Total number of days the filter has been overused
  
  start string
  
  ISO8601 encoded date of when the filter was installed
  
  lifecycle_overuse_count number
  
  The total number of days the type of filter has been overused in the time period
  
  maintenance_count number
  
  The total number of maintenance of the type registered in a time period
  
  maintenance_interval number
  
  Number of days of the maintenance window for the active filter of this type
  
  pre_filter object
  
  Hide pre_filter attributes Show pre_filter attributes object
  
  est_annual_volume_count number
  
  The estimated number of filters to be used in a year, considering the number in the time period
  
  filter_interval_log array[object]
  
  List of filter maintenances of this type that have existed for the booth.
  
  One filter of some type with its maintenance data
  
  Hide filter_interval_log attributes Show filter_interval_log attributes object
  
  duration number
  
  Lifetime for this particular filter
  
  filter_estimated_duration number
  
  Total estimated duration of the filter
  
  filter_maintenance_duration number
  
  Number of days for the maintenance window
  
  filter_nominal_duration number
  
  Lifetime - maintenance window
  
  filter_overuse_duration number
  
  Total number of days the filter has been overused
  
  start string
  
  ISO8601 encoded date of when the filter was installed
  
  last_active_filter object
  
  One filter of some type with its maintenance data
  
  Hide last_active_filter attributes Show last_active_filter attributes object
  
  duration number
  
  Lifetime for this particular filter
  
  filter_estimated_duration number
  
  Total estimated duration of the filter
  
  filter_maintenance_duration number
  
  Number of days for the maintenance window
  
  filter_nominal_duration number
  
  Lifetime - maintenance window
  
  filter_overuse_duration number
  
  Total number of days the filter has been overused
  
  start string
  
  ISO8601 encoded date of when the filter was installed
  
  lifecycle_overuse_count number
  
  The total number of days the type of filter has been overused in the time period
  
  maintenance_count number
  
  The total number of maintenance of the type registered in a time period
  
  maintenance_interval number
  
  Number of days of the maintenance window for the active filter of this type
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/booths/{id}/filter_maintenances

curl \
 --request GET 'http://localhost:4000/api/booths/{id}/filter_maintenances?end=string' \
 --header "Authorization: $API_KEY"

Response examples (200)

{
  "data": {
    "exhaust_filter": {
      "est_annual_volume_count": 42.0,
      "filter_interval_log": [
        {
          "duration": 42.0,
          "filter_estimated_duration": 42.0,
          "filter_maintenance_duration": 42.0,
          "filter_nominal_duration": 42.0,
          "filter_overuse_duration": 42.0,
          "start": "string"
        }
      ],
      "last_active_filter": {
        "duration": 42.0,
        "filter_estimated_duration": 42.0,
        "filter_maintenance_duration": 42.0,
        "filter_nominal_duration": 42.0,
        "filter_overuse_duration": 42.0,
        "start": "string"
      },
      "lifecycle_overuse_count": 42.0,
      "maintenance_count": 42.0,
      "maintenance_interval": 42.0
    },
    "intake_filter": {
      "est_annual_volume_count": 42.0,
      "filter_interval_log": [
        {
          "duration": 42.0,
          "filter_estimated_duration": 42.0,
          "filter_maintenance_duration": 42.0,
          "filter_nominal_duration": 42.0,
          "filter_overuse_duration": 42.0,
          "start": "string"
        }
      ],
      "last_active_filter": {
        "duration": 42.0,
        "filter_estimated_duration": 42.0,
        "filter_maintenance_duration": 42.0,
        "filter_nominal_duration": 42.0,
        "filter_overuse_duration": 42.0,
        "start": "string"
      },
      "lifecycle_overuse_count": 42.0,
      "maintenance_count": 42.0,
      "maintenance_interval": 42.0
    },
    "pre_filter": {
      "est_annual_volume_count": 42.0,
      "filter_interval_log": [
        {
          "duration": 42.0,
          "filter_estimated_duration": 42.0,
          "filter_maintenance_duration": 42.0,
          "filter_nominal_duration": 42.0,
          "filter_overuse_duration": 42.0,
          "start": "string"
        }
      ],
      "last_active_filter": {
        "duration": 42.0,
        "filter_estimated_duration": 42.0,
        "filter_maintenance_duration": 42.0,
        "filter_nominal_duration": 42.0,
        "filter_overuse_duration": 42.0,
        "start": "string"
      },
      "lifecycle_overuse_count": 42.0,
      "maintenance_count": 42.0,
      "maintenance_interval": 42.0
    }
  }
}

Response examples (400)

{
  "error": "Error Reason"
}

Response examples (400)

{
  "error": "Error Reason"
}

Response examples (401)

{
  "error": "Error Reason"
}

Response examples (401)

{
  "error": "Error Reason"
}