Get booth runtime

GET /api/booths/{id}/runtime

Allows you to retrieve the runtime of a booth in the given period and the immediate previous period of the same length, and the delta between them.

Path parameters

id string Required

id of the booth

Query parameters

unit string Required

Unit of window to get the runtime
length numeric

Number of units in the given units

Responses

200 application/json

OK
Hide response attributes Show response attributes object
- current_period object
  
  Hide current_period attributes Show current_period attributes object
  
  days number
  
  Amount of days
  
  microsecs number
  
  Amount of microseconds
  
  months number
  
  Amount of months
  
  secs number
  
  Amount of seconds
- delta object
  
  Hide delta attributes Show delta attributes object
  
  days number
  
  Amount of days
  
  microsecs number
  
  Amount of microseconds
  
  months number
  
  Amount of months
  
  secs number
  
  Amount of seconds
- previous_period object
  
  Hide previous_period attributes Show previous_period attributes object
  
  days number
  
  Amount of days
  
  microsecs number
  
  Amount of microseconds
  
  months number
  
  Amount of months
  
  secs number
  
  Amount of seconds
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}/runtime

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

Response examples (200)

{
  "current_period": {
    "days": 42.0,
    "microsecs": 42.0,
    "months": 42.0,
    "secs": 42.0
  },
  "delta": {
    "days": 42.0,
    "microsecs": 42.0,
    "months": 42.0,
    "secs": 42.0
  },
  "previous_period": {
    "days": 42.0,
    "microsecs": 42.0,
    "months": 42.0,
    "secs": 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"
}