Get historic runtime

GET /api/booths/{id}/runtime_series

Allows you to retrieve the requested number of time buckets between a given date range with the total minutes of runtime for each bucket.

Path parameters

id string Required

id of the booth

Query parameters

start string Required

ISO8601 formatted date to query data from
datapoints string Required

Number of data points to request
states string

List of comma-separated values to include in the count
end string Required

ISO8601 formatted date to query data until

Responses

200 application/json

OK
Hide response attribute Show response attribute object
- data array[object]
  
  Series of runtime minutes aggregated in time buckets depending on the datapoints
  
  Hide data attributes Show data attributes object
  
  time string
  
  ISO8601 formatted timestamp
  
  value number
  
  Number of minutes of runtime in the bucket
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_series

curl \
 --request GET 'http://localhost:4000/api/booths/{id}/runtime_series?start=string&datapoints=string&end=string' \
 --header "Authorization: $API_KEY"

Response examples (200)

{
  "data": [
    {
      "time": "string",
      "value": 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"
}