GET /api/reports/booth_run_consistency
Api key

Get the booth run consistency report data by booth for the filters given. A run is a contiguous sequence of active modes (Spray Mode, Flash Mode, Purge Mode, Bake Mode, Cool Down). Measures how uniform run durations are within the period using the Gini coefficient, median, min, max, and key percentiles.

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.

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

    • gini_coefficient number

      Gini coefficient of run durations (0 = all equal, 1 = maximally unequal). Null when run_count is 0.

    • inserted_at string

      ISO8601 formatted datetime when the report data was created.

    • max_duration_minutes number

      Longest run duration in minutes. Null when run_count is 0.

    • median_duration_minutes number

      Median run duration in minutes. Null when run_count is 0.

    • min_duration_minutes number

      Shortest run duration in minutes. Null when run_count is 0.

    • p05_duration_minutes number

      5th percentile run duration in minutes. Null when run_count is 0.

    • p25_duration_minutes number

      25th percentile run duration in minutes. Null when run_count is 0.

    • p75_duration_minutes number

      75th percentile run duration in minutes. Null when run_count is 0.

    • p95_duration_minutes number

      95th percentile run duration in minutes. Null when run_count is 0.

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

    • run_count number

      Total number of booth runs in the period.

    • updated_at string

      ISO8601 formatted datetime when the report data was last modified.
  • 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/booth_run_consistency 
curl \
 --request GET 'http://localhost:4000/api/reports/booth_run_consistency?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",
  "run_count": 35,
  "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",
  "gini_coefficient": 0.24,
  "max_duration_minutes": 120.0,
  "min_duration_minutes": 15.0,
  "p05_duration_minutes": 17.5,
  "p25_duration_minutes": 28.3,
  "p75_duration_minutes": 68.2,
  "p95_duration_minutes": 108.7,
  "median_duration_minutes": 42.0
}
Response examples (400) 
{
  "error": "Error Reason"
}
Response examples (401) 
{
  "error": "Error Reason"
}