Get utilization summary

GET /api/booths/{id}/utilization_summary
Api key

Allows you to retrieve a summary of utilization, including totals of time in use, idle, in active spray, etc.

Path parameters

  • id string Required

    id of the booth

Query parameters

  • start string Required

    ISO8601 formatted date to query data from

  • end string Required

    ISO8601 formatted date to query data until

Responses

  • 200 application/json

    OK

    Hide response attribute Show response attribute object
    • data object

      Total time spent in the different relevant states for the queried time period.

      Hide data attributes Show data attributes object
      • all_active_modes number

        Total time when data were received in the requested time period.

      • bake number

        Total time the booth spent in any of the different bake modes

      • idle number

        Time in the requested period where no data were received.

      • in_use number

        Time spent in Spray, Flash, Purge, or Bake mode.
  • 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}/utilization_summary 
curl \
 --request GET 'http://localhost:4000/api/booths/{id}/utilization_summary?start=string&end=string' \
 --header "Authorization: $API_KEY"
Response examples (200) 
{
  "data": {
    "all_active_modes": 42.0,
    "bake": 42.0,
    "idle": 42.0,
    "in_use": 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"
}