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 application/json

    OK

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

      Filter Service data

      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 the summary belongs to

      • exhaust_filter object
        Hide exhaust_filter attributes Show exhaust_filter attributes object
        • est_remaining_service_count number

          Estimated number of services remaining at current usage.

        • filter_type string

          Type of the filter

          Values are exhaust_filter, intake_filter, or pre_filter.

        • filter_volume string

          Category of filter usage

          Values are low, low_mid, mid, mid_high, or high.

        • late_service_count number

          Count of late services performed for the filter type in the time period.

        • maintenance_event_count number

          Count of services performed for the filter type in the time period.

        • on_time_service_count number

          Count of timely services performed for the filter type in the time period.

      • facility_id string

        ID of the facility the booth belongs to

      • intake_filter object
        Hide intake_filter attributes Show intake_filter attributes object
        • est_remaining_service_count number

          Estimated number of services remaining at current usage.

        • filter_type string

          Type of the filter

          Values are exhaust_filter, intake_filter, or pre_filter.

        • filter_volume string

          Category of filter usage

          Values are low, low_mid, mid, mid_high, or high.

        • late_service_count number

          Count of late services performed for the filter type in the time period.

        • maintenance_event_count number

          Count of services performed for the filter type in the time period.

        • on_time_service_count number

          Count of timely services performed for the filter type in the time period.

      • pre_filter object
        Hide pre_filter attributes Show pre_filter attributes object
        • est_remaining_service_count number

          Estimated number of services remaining at current usage.

        • filter_type string

          Type of the filter

          Values are exhaust_filter, intake_filter, or pre_filter.

        • filter_volume string

          Category of filter usage

          Values are low, low_mid, mid, mid_high, or high.

        • late_service_count number

          Count of late services performed for the filter type in the time period.

        • maintenance_event_count number

          Count of services performed for the filter type in the time period.

        • on_time_service_count number

          Count of timely services performed for the filter type in the time period.

      • region_id string

        ID of the region the booth belongs to
  • 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/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",
        "late_service_count": 42.0,
        "maintenance_event_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",
        "late_service_count": 42.0,
        "maintenance_event_count": 42.0,
        "on_time_service_count": 42.0
      },
      "pre_filter": {
        "est_remaining_service_count": 42.0,
        "filter_type": "exhaust_filter",
        "filter_volume": "low",
        "late_service_count": 42.0,
        "maintenance_event_count": 42.0,
        "on_time_service_count": 42.0
      },
      "region_id": "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"
}