Get utilization resume of all booths in Facility

GET /api/facilities/{id}/utilization
Api key

Returns a list of objects with the summed utilization for each mode for all booths associated to the given Facility.

Path parameters

  • id string Required

    id of the facility

Query parameters

  • from string Required

    an ISO8601 formatted date to query data from

  • to string Required

    an ISO8601 formatted date to query data until

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • duration number

      Interval of time in minutes

    • mode string

      Name of the mode the booths were on

    • percentage number

      Percentage of duration with respect all modes
  • 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/facilities/{id}/utilization 
curl \
 --request GET 'http://localhost:4000/api/facilities/{id}/utilization?from=string&to=string' \
 --header "Authorization: $API_KEY"
Response examples (200) 
{
  "mode": "Spray Mode",
  "duration": 5.0,
  "percentage": 55.0
}
Response examples (200) 
{
  "mode": "Spray Mode",
  "duration": 5.0,
  "percentage": 55.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"
}