Get a summary of filter services per booth

GET /api/filters/services
Api key

Allows you to retrieve a summary of filter usage by booth with relevant stats.

Query parameters

  • filter string

    criteria to filter by

  • start string Required

    ISO8601 date from when to include data

  • end string Required

    ISO8601 date until when to include data

Responses

  • 200

    OK

    Hide response attribute Show response attribute object
    • data array[object]

      Filter Service data

      Hide data attributes Show data attributes object
  • 400

    Bad Request

    Hide response attribute Show response attribute object
    • error string

      Human readable version of the error status code
  • 401

    Unauthorized

    Hide response attribute Show response attribute object
    • error string

      Human readable version of the error status code
GET /api/filters/services 
curl \
 --request GET http://localhost:4000/api/filters/services?start=string&end=string \
 --header "Authorization: $API_KEY"
Response examples (200) 
{
  "data": [
    {
      "account_id": "string",
      "booth_id": "string",
      "exhaust_filter": {
        "est_remaining_service_count": 42.0,
        "filter_type": "exhaust_filter",
        "filter_volume": "low",
        "maintenance_event_count": 42.0,
        "missed_service_count": 42.0,
        "on_time_service_count": 42.0
      },
      "facility_id": "string",
      "intake_filter": {
        "est_remaining_service_count": 42.0,
        "filter_type": "exhaust_filter",
        "filter_volume": "low",
        "maintenance_event_count": 42.0,
        "missed_service_count": 42.0,
        "on_time_service_count": 42.0
      },
      "pre_filter": {
        "est_remaining_service_count": 42.0,
        "filter_type": "exhaust_filter",
        "filter_volume": "low",
        "maintenance_event_count": 42.0,
        "missed_service_count": 42.0,
        "on_time_service_count": 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"
}