Query parameters

• filter string

  criteria to filter by

• sort string

  criteria to sort by

• limit string

  amount of results per page to return

• page string

  page number

• start string Required

  ISO8601 formatted date to query data from

• format string

  Format in which to request the response. Defaults to JSON

  Values are csv or json.

• includes string

  optional features to include. This is a list of values separated by colons ':'. The avaiable values are: cycle_count (adds cycles_count), utilization_times (adds utilization_minutes and working_minutes), energy_usage (adds kwh_usage and gas_usage), active_alerts (adds active_alerts_count), service_events_count (adds service_events and events_missed), and overuse_data (adds overuse_minutes and overuse_cycles)

• search string

  criteria to search by

• end string

  ISO8601 formatted date to query data until

Responses

• 200 application/json

  OK

  Hide response attributes Show response attributes object

  • data array[object]

    Facilities data

    Hide data attributes Show data attributes object

    • account_id string

      Id of the account the facility belongs to

    • active_alerts number

      The number of active alerts on booths in the facility

    • address_line_1 string

      First line of the facility address

    • address_line_2 string

      Second line of the facility address

    • booths number

      The number of booths associated to the facility

    • city string

      City where the facility is located

    • climate_control string

      The type of climate control the facility has. Can be one of 'both', 'heated_only', 'cooled_only', or 'none'

    • cycle_count number

      The number of cycles completed across all booths in the facility for a time period

    • distributor_id string

      id of the distributor associated to the facility

    • events_missed number

      The number of service events that were supposed to happen over the time period but didn't.

    • gas_usage number

      The number of BTU used by the booths in the facility over the time period

    • id string

      ID of the facility in the system

    • kwh_usage number

      The number of kWh used by the booths in the facility over the time period

    • name string

      Name of the facility

    • overuse_cycles number

      The number of cycles that happened during overuse for booths in the facility over the time period

    • overuse_minutes number

      The minutes of utilization that happened during overuse for booths in the facility over the time period.

    • region_id string

      ID of the region the facility belongs to

    • region_name string

      Name of the region the facility belongs to

    • service_events number

      The number of service events performed in the facility over the time period.

    • square_ft number

      The square footage of the facility

    • state string

      State where the facility is located

    • status string

      Status of the facility.

    • store_number string

      Identifier of the facility

    • type string

      The type of facility. One of auto_body_shop, manufacturing_plant, or auto_dealership

    • tz string

      The timezone of the facility as a IANA TZ identifier string

    • utilization_minutes number

      The minutes of utilization recorded for the booths in the facility over the time period

    • working_hours array[object]

      List of facility schedules for the week

      Hide working_hours attributes Show working_hours attributes object

      • day string

        The day of the week. Should be all lowercase

      • enabled string

        Boolean indicating whether the facility operates on this day of the week

      • start string

        The ISO8601 formatted time when the facility starts operating on this day of the week

      • stop string

        The ISO8601 formatted time when the facility stops operating on this day of the week

    • working_minutes number

      The total working hours for the facility, in minutes, for the days in the time period.

    • zipcode string

      Zip code of the facility

  • limit number

    The number of items per page currently applied

  • page number

    The number of the page returned

  • pages number

    The total number of pages matching the current search

  • total number

    The total number of facilities matching the query

• 401 application/json

  Unauthorized

  Hide response attribute Show response attribute object

  • error string

    Human readable version of the error status code