Get a cycles vs in use time report

GET /api/reports/cycles_utilization
Api key

get the cycles vs time in use report data by booth for the filters given

Query parameters

  • filter string

    criteria to filter by

  • period_type string Required

    time period of the report

    Values are monthly, quarterly, or yearly.

  • period_start string Required

    ISO8601 formatted date for the beginning of the requested period

  • format string

    Format in which to request the response. Defaults to JSON

    Values are csv or json.

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • account_id string

      ID of the account the booth with the data belongs to.

    • account_name string

      Name of the account the booth with the data belongs to.

    • booth_id string

      ID of the booth the data belongs to.

    • booth_name string

      Name of the booth the data belongs to.

    • cycle_count number

      The number of cycles the booth reported in the requested period.

    • facility_id string

      ID of the facility the booth with the data belongs to.

    • facility_name string

      Name of the facility the booth with the data belongs to.

    • in_use_time_minutes number

      The number of in-use minutes the booth reported in the requested period.

    • inserted_at string

      ISO8601 formatted datetime when the report data was created.

    • period_start string

      ISO8601 formatted date marking the start of the reported period.

    • period_type string

      The type of period of the report. monthly | quarterly | yearly.

    • region_id string

      ID of the region the booth with the data belongs to.

    • region_name string

      Name of the region the booth with the data belongs to.

    • updated_at string

      ISO8601 formatted datetime when the report data was last modified. (Should always match created at)
  • 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/reports/cycles_utilization 
curl \
 --request GET 'http://localhost:4000/api/reports/cycles_utilization?period_type=monthly&period_start=string' \
 --header "Authorization: $API_KEY"
Response examples (200) 
{
  "booth_id": "a2d136b7-8940-44ed-ba34-500263fb4871",
  "region_id": "1763a59a-83f6-46f2-8347-8cb48c83c3be",
  "account_id": "a0d52533-5a8b-4f30-89fa-54be1c45cf70",
  "booth_name": "Booth 1",
  "updated_at": "2025-09-09 23:38:03",
  "cycle_count": 1,
  "facility_id": "1a309ee7-d332-4af5-bae8-c209e1e576ae",
  "inserted_at": "2025-09-09 23:38:03",
  "period_type": "monthly",
  "region_name": "Test Region",
  "account_name": "Test Account",
  "period_start": "2025-08-01",
  "facility_name": "Test Facility 2",
  "in_use_time_minutes": 93
}
Response examples (200) 
{
  "booth_id": "a2d136b7-8940-44ed-ba34-500263fb4871",
  "region_id": "1763a59a-83f6-46f2-8347-8cb48c83c3be",
  "account_id": "a0d52533-5a8b-4f30-89fa-54be1c45cf70",
  "booth_name": "Booth 1",
  "updated_at": "2025-09-09 23:38:03",
  "cycle_count": 1,
  "facility_id": "1a309ee7-d332-4af5-bae8-c209e1e576ae",
  "inserted_at": "2025-09-09 23:38:03",
  "period_type": "monthly",
  "region_name": "Test Region",
  "account_name": "Test Account",
  "period_start": "2025-08-01",
  "facility_name": "Test Facility 2",
  "in_use_time_minutes": 93
}
Response examples (400) 
{
  "error": "Error Reason"
}
Response examples (400) 
{
  "error": "Error Reason"
}
Response examples (401) 
{
  "error": "Error Reason"
}
Response examples (401) 
{
  "error": "Error Reason"
}