Get booth recent stages

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

Allows you to retrieve the list of stages or modes that a booth has been in since a given start date until now.

Path parameters

  • id string Required

    id of the booth

Query parameters

  • start string Required

    an ISO8601 formatted date to query data from

Responses

  • 200 application/json

    OK

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

      Stage history

      Hide data attributes Show data attributes object
      • end_time string

        ISO8601 encoded timestamp when stage ended

      • mode string

        Name of the stage the booth was on

      • start_time string

        ISO8601 encoded timestamp when stage started

    • limit number

      The number of items per page currently applied

    • page number

      The number of the page returned

    • pages number

      The total number of pages matching the current search

    • total number

      The total number of stages matching the query
  • 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}/recent_stages 
curl \
 --request GET 'http://localhost:4000/api/booths/{id}/recent_stages?start=string' \
 --header "Authorization: $API_KEY"
Response examples (200) 
{
  "data": [
    {
      "mode": "Spray Mode",
      "end_time": "2024-01-01 05:00:03Z",
      "start_time": "2024-01-01 00:00:00Z"
    }
  ],
  "page": 1,
  "limit": 25,
  "pages": 1,
  "total": 0
}
Response examples (200) 
{
  "data": [
    {
      "mode": "Spray Mode",
      "end_time": "2024-01-01 05:00:03Z",
      "start_time": "2024-01-01 00:00:00Z"
    }
  ],
  "page": 1,
  "limit": 25,
  "pages": 1,
  "total": 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"
}