Get modes duration

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

Allows you to retrieve the list of modes and their duration for a given booth in a given date range.

Path parameters

  • id string Required

    id of the booth

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 attribute Show response attribute object
    • data array[object]

      List of durations per booth mode

      Hide data attributes Show data 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/booths/{id}/duration_by_mode 
curl \
 --request GET 'http://localhost:4000/api/booths/{id}/duration_by_mode?from=string&to=string' \
 --header "Authorization: $API_KEY"
Response examples (200) 
{
  "data": [
    {
      "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"
}