Skip to main content

Excessive Usage API

The Excessive Usage API exposes Trackunit's excessive-usage analytics data. Excessive usage represents the portion of an asset's operating time that exceeds the configured usage thresholds. It exposes per-asset and per-customer summaries of usage that exceeds the limits defined in active rental contracts, so that rental businesses can identify, report, and bill for excessive use.

IrisX Subscription requirement

The Excessive Usage API is only available to customers on IrisX. Learn more about the IrisX subscription.

Early access

Please be aware that the Excessive Usage API is currently in early access (beta) and is only available upon request. The interface and behavior may change before general availability.

Concepts​

The API is built on the following concepts:

  • Asset is a trackable piece of equipment, e.g. a machine or an accessory.
  • Contract defines when an asset is rented out to a customer and the agreed usage limits.
  • Customer is the renting party associated with one or more contracts (see the Customer API).
  • Excessive usage is the portion of an asset's usage during the contract period that exceeds the agreed limits.

Constraints​

  • Excessive usage is calculated against active rental contracts; assets without a contract are not included in the results.