Get utilization trends

GET /api/utilization/trends

Compare the time of utilization, cycles, energy, and gas usage for the requested interval vs the typical all-time stats for the same interval.

Query parameters

filter string

criteria to filter by
start string Required

ISO8601 formatted date marking the start of the current period
end string Required

ISO8601 formatted date marking the end of the current period

Responses

200 application/json

OK
Hide response attribute Show response attribute object
- data object
  
  Trend of utilization data
  
  Hide data attributes Show data attributes object
  
  cycles object
  
  Hide cycles attribute Show cycles attribute object
  
  data object
  
  Information about all time value, current value, and percentage of change between them.
  
  Hide data attributes Show data attributes object
  
  all_time number
  
  All-time value of the requested trend.
  
  current_period number
  
  Value of the requested trend for the current period.
  
  pct_change number
  
  Float value with the percentual difference between current period and all-time.
  
  energy_usage object
  
  Hide energy_usage attribute Show energy_usage attribute object
  
  data object
  
  Information about all time value, current value, and percentage of change between them.
  
  Hide data attributes Show data attributes object
  
  all_time number
  
  All-time value of the requested trend.
  
  current_period number
  
  Value of the requested trend for the current period.
  
  pct_change number
  
  Float value with the percentual difference between current period and all-time.
  
  gas_usage object
  
  Hide gas_usage attribute Show gas_usage attribute object
  
  data object
  
  Information about all time value, current value, and percentage of change between them.
  
  Hide data attributes Show data attributes object
  
  all_time number
  
  All-time value of the requested trend.
  
  current_period number
  
  Value of the requested trend for the current period.
  
  pct_change number
  
  Float value with the percentual difference between current period and all-time.
  
  median_cycles object
  
  Hide median_cycles attribute Show median_cycles attribute object
  
  data object
  
  Information about all time value, current value, and percentage of change between them.
  
  Hide data attributes Show data attributes object
  
  all_time number
  
  All-time value of the requested trend.
  
  current_period number
  
  Value of the requested trend for the current period.
  
  pct_change number
  
  Float value with the percentual difference between current period and all-time.
  
  utilization_time object
  
  Utilization trends per mode
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/trends

curl \
 --request GET 'http://localhost:4000/api/utilization/trends?start=string&end=string' \
 --header "Authorization: $API_KEY"

Response examples (200)

{
  "data": {
    "cycles": {
      "all_time": 3,
      "pct_change": -33.333,
      "current_period": 2
    },
    "gas_usage": {
      "all_time": 10000,
      "pct_change": -25,
      "current_period": 7500
    },
    "energy_usage": {
      "all_time": 10000,
      "pct_change": 0,
      "current_period": 10000
    },
    "median_cycles": {
      "all_time": 2,
      "pct_change": 0,
      "current_period": 2
    },
    "utilization_time": {
      "Booth Off": {
        "all_time": 1000,
        "pct_change": -25,
        "current_period": 750
      },
      "Cool Down": {
        "all_time": 1000,
        "pct_change": -25,
        "current_period": 750
      },
      "Flash Mode": {
        "all_time": 1000,
        "pct_change": -25,
        "current_period": 750
      },
      "Purge Mode": {
        "all_time": 1000,
        "pct_change": -25,
        "current_period": 750
      },
      "Spray Mode": {
        "all_time": 1000,
        "pct_change": -25,
        "current_period": 750
      },
      "Bake Set Pt 1": {
        "all_time": 1000,
        "pct_change": -25,
        "current_period": 750
      },
      "Bake Set Pt 2": {
        "all_time": 1000,
        "pct_change": -25,
        "current_period": 750
      },
      "Bake Set Pt 3": {
        "all_time": 1000,
        "pct_change": -25,
        "current_period": 750
      },
      "Cycle Complete": {
        "all_time": 1000,
        "pct_change": -25,
        "current_period": 750
      },
      "Energy Conservation": {
        "all_time": 1000,
        "pct_change": -25,
        "current_period": 750
      }
    }
  }
}

Response examples (400)

{
  "error": "Error Reason"
}

Response examples (401)

{
  "error": "Error Reason"
}