# Get a cycles vs in use time report

**GET /api/reports/cycles_utilization**

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


## Servers
- http://localhost:4000: http://localhost:4000 ()


## Authentication methods
- Api key


## Parameters


### Query parameters
- **filter** (string)
  criteria to filter by
- **period_type** (string)
  time period of the report
- **period_start** (string)
  ISO8601 formatted date for the beginning of the requested period
- **format** (string)
  Format in which to request the response. Defaults to JSON


## Responses
### 200
OK

#### Body: application/json (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
Bad request

#### Body: application/json (object)
- **error** (string)
  Human readable version of the error status code

### 401
Unauthorized

#### Body: application/json (object)
- **error** (string)
  Human readable version of the error status code


[Powered by Bump.sh](https://bump.sh)