Get the utilization of all booths within scope

GET /api/utilization
Api key

Allows you to retrieve the utilization stats of one or multiple booths. Per facility, account, region, and others.

Query parameters

  • filter string

    criteria to filter by. Can be an account, facility, region, or booth id. If empty returns for all booths in scope

  • start string Required

    ISO8601 formatted date to query data from

  • 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]

      Booths utilization data

      Hide data attributes Show data attributes object
      • account_id string

        ID of the account the booth belongs to in the application

      • booth_id string

        ID of the booth within the application

      • btu_usage number

        The total number of BTU used in the time period

      • cycle_count number

        Number of cycles completed in the requested period

      • duration number

        Duration in minutes of the requested period

      • facility_id string

        ID of the facility the booth belongs to in the application

      • kw_usage number

        The total number of kilo-Watts used in the time period

      • modes array[object]

        Duration the booth spent in the different modes

        Hide modes attributes Show modes attributes object
        • duration number

          Number of minutes the booth spent in that mode

        • mode string

          Name of the mode the booth was in

      • region_id string

        ID of the region the booth belongs to in the application

      • timestamp string

        ISO8601 encoded timestamp marking the start of the period requested
  • 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/utilization 
curl \
 --request GET 'http://localhost:4000/api/utilization?start=string&end=string' \
 --header "Authorization: $API_KEY"
Response examples (200) 
{
  "data": [
    {
      "modes": [
        {
          "mode": "Bake Set Pt 1",
          "duration": 300
        }
      ],
      "booth_id": "3317efbd-0049-48d4-bb7f-1abb3901ac8f",
      "duration": 1440,
      "kw_usage": 53.292313,
      "btu_usage": 12.329392,
      "region_id": "3317efbd-0049-48d4-bb7f-0909018293ca",
      "timestamp": "2024-12-09 10:00:00Z",
      "account_id": "3317efbd-0049-48d4-bb7f-38a92baca811",
      "cycle_count": 3,
      "facility_id": "3317efbd-0049-48d4-bb7f-10293748aa9c"
    }
  ]
}
Response examples (200) 
{
  "data": [
    {
      "modes": [
        {
          "mode": "Bake Set Pt 1",
          "duration": 300
        }
      ],
      "booth_id": "3317efbd-0049-48d4-bb7f-1abb3901ac8f",
      "duration": 1440,
      "kw_usage": 53.292313,
      "btu_usage": 12.329392,
      "region_id": "3317efbd-0049-48d4-bb7f-0909018293ca",
      "timestamp": "2024-12-09 10:00:00Z",
      "account_id": "3317efbd-0049-48d4-bb7f-38a92baca811",
      "cycle_count": 3,
      "facility_id": "3317efbd-0049-48d4-bb7f-10293748aa9c"
    }
  ]
}
Response examples (400) 
{
  "error": "Error Reason"
}
Response examples (400) 
{
  "error": "Error Reason"
}
Response examples (401) 
{
  "error": "Error Reason"
}
Response examples (401) 
{
  "error": "Error Reason"
}