Get a crunch time report

GET /api/reports/crunch_time

Get the crunch time report data by booth for the filters given. Compares end-of-period production activity against the overall period mean. Monthly reports include weekly crunch; quarterly adds monthly crunch; yearly adds quarterly crunch.

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 belongs to.
- account_name string
  
  Name of the account the booth belongs to.
- booth_id string
  
  ID of the booth.
- booth_name string
  
  Name of the booth.
- facility_id string
  
  ID of the facility the booth belongs to.
- facility_name string
  
  Name of the facility the booth belongs to.
- inserted_at string
  
  ISO8601 formatted datetime when the report data was created.
- monthly_crunch_mean_cycles number
  
  Average cycles per week day in the last 20% of each calendar month's week days. Null for monthly period type.
- monthly_crunch_mean_utilization_minutes number
  
  Average utilization minutes per week day in the last 20% of each month's week days. Null for monthly period type.
- overall_mean_cycles number
  
  Average cycles per week day across the full report period.
- overall_mean_utilization_minutes number
  
  Average utilization minutes per week day across the full report period.
- 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.
- quarterly_crunch_mean_cycles number
  
  Average cycles per week day in the last 20% of each calendar quarter's week days. Null for monthly and quarterly period types.
- quarterly_crunch_mean_utilization_minutes number
  
  Average utilization minutes per week day in the last 20% of each quarter's week days. Null for monthly and quarterly period types.
- region_id string
  
  ID of the region the booth belongs to.
- region_name string
  
  Name of the region the booth belongs to.
- updated_at string
  
  ISO8601 formatted datetime when the report data was last modified.
- weekly_crunch_mean_cycles number
  
  Average cycles per week day on Fridays (end-of-week crunch).
- weekly_crunch_mean_utilization_minutes number
  
  Average utilization minutes per week day on Fridays.
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/crunch_time

curl \
 --request GET 'http://localhost:4000/api/reports/crunch_time?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",
  "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",
  "overall_mean_cycles": 12.5,
  "weekly_crunch_mean_cycles": 18.2,
  "overall_mean_utilization_minutes": 95.3,
  "weekly_crunch_mean_utilization_minutes": 142.7
}

Response examples (400)

{
  "error": "Error Reason"
}

Response examples (401)

{
  "error": "Error Reason"
}