Get modes frequency

GET /api/booths/{id}/frequency_by_mode

Allows you to retrieve a list of modes or stages with their frequency of usage for the 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

    OK

    Hide response attribute Show response attribute object
    • data array[object]

      List of frequency per booth mode

      Hide data attributes Show data attributes object
      • frequency number

        Amount of times the booth was used in the given stage

      • mode string

        Name of the mode the booth was on
  • 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}/frequency_by_mode 
curl \
 -X GET http://localhost:4000/api/booths/{id}/frequency_by_mode?from=string&to=string
Response examples (200) 
{
  "data": [
    {
      "mode": "Spray Mode",
      "frequency": 41
    }
  ]
}
Response examples (400) 
{
  "error": "Error Reason"
}
Response examples (400) 
{
  "error": "Error Reason"
}
Response examples (401) 
{
  "error": "Error Reason"
}
Response examples (401) 
{
  "error": "Error Reason"
}