Get utilization stats

GET /api/booths/{id}/utilization_stats

Allows you to retrieve utilization statistics for sessions. Like avg session duration, sum of session durations, and sessions count in the time period.

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

OK
Hide response attribute Show response attribute object
- data array[object]
  
  List of summary statistics per booth mode
  
  Hide data attributes Show data attributes object
  
  avg number
  
  The average session duration in minutes. total / count
  
  count number
  
  The total count of sessions for the mode.
  
  mode string
  
  The mode to which the associated stats belong.
  
  total number
  
  The total time of minutes spent in the mode.
400

Bad request
Hide response attribute Show response attribute object
- error string
  
  Human readable version of the error status code
401

Unauthorized
Hide response attribute Show response attribute object
- error string
  
  Human readable version of the error status code

GET /api/booths/{id}/utilization_stats

curl \
 -X GET http://localhost:4000/api/booths/{id}/utilization_stats?start=string&end=string

Response examples (200)

{
  "data": [
    {
      "avg": 42.0,
      "count": 42.0,
      "mode": "string",
      "total": 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"
}