Authentication

Endpoint to authenticate the user and obtain an access token for accessing any entitled enpoints. This follows the OAuth 2.0 password based grant. Please note that a successful response from this endpoint is the only one of type application/json, as required by the OAuth 2.0 specification. The unsuccessful responses maintain the application/xml type for consistency with the rest of AEMP API. The same user may successfully log-in once per second, on average. Occasional log-in bursts are allowed, and the maximum lock-out time is 2 seconds. Failed login attempts are throttled more aggressively, using an exponentially increasing lock-out times.

post

Obtain an access token for a given user.

Fleet snapshots

Endpoints to retrieve snapshots of an entire Fleet or a specific Equipment.

get

Get the first page of the Equipment listing.

get

Get a specific page of the Equipment listing.

get

Get a specific Equipment by its PIN or VIN, including latest reported values of its metrics.

Fleet timeseries

Endpoints to retrieve timeseries for a specific metric.

get

Get links to timeseries of all metrics available for the given PIN or VIN in the given time-range This method makes its best effort to only include links to metrics that contain a datapoint in the requested range. However, due to implementation details, it may sometimes return false-positives (i.e. links that will yield 0 datapoints when queried).

get

Gets the latest available data points for Distance timeseries for the given PIN or VIN in the default time-range (i.e. last 2 weeks).

Distance metric is cumulative distance travelled

  • PDC metric key used value.common.machine.distance.total
  • PDC unit expected predefined.unit.length.KILOMETER
get

Gets the latest available data points for Distance timeseries for the given PIN or VIN in the given time-range.

Distance metric is cumulative distance travelled

  • PDC metric key used value.common.machine.distance.total
  • PDC unit expected predefined.unit.length.KILOMETER
get

Gets the latest available data points for CumulativeFuelUsed timeseries for the given PIN or VIN in the default time-range (i.e. last 2 weeks).

Metric represents the cumulative amount of fuel used by the machine since its manufacture.

  • PDC metric key used value.common.engine.fuel.used.total
  • PDC unit expected predefined.unit.volume.LITER
get

Gets the latest available data points for CumulativeFuelUsed timeseries for the given PIN or VIN in the given time-range.

Metric represents the cumulative amount of fuel used by the machine since its manufacture.

  • PDC metric key used value.common.engine.fuel.used.total
  • PDC unit expected predefined.unit.volume.LITER
get

Gets the latest available data points for CumulativeIdleHours timeseries for the given PIN or VIN in the default time-range (i.e. last 2 weeks).

The current lifetime total cumulative idle operating hours of the machine. The definition of idle state is unique to each manufacturer.

  • PDC metric key used value.common.machine.hours.oem.specific.total
  • PDC unit expected predefined.unit.HOUR
get

Gets the latest available data points for CumulativeIdleHours timeseries for the given PIN or VIN in the given time-range.

The current lifetime total cumulative idle operating hours of the machine. The definition of idle state is unique to each manufacturer.

  • PDC metric key used value.common.machine.hours.oem.specific.total
  • PDC unit expected predefined.unit.HOUR
get

Gets the latest available data points for CumulativeLoadCount timeseries for the given PIN or VIN in the default time-range (i.e. last 2 weeks).

Lifetime total cumulative number of loads the machine has achieved.

  • PDC metric key used value.common.machine.load.count.total
  • PDC unit expected predefined.unit.NUMBER
get

Gets the latest available data points for CumulativeLoadCount timeseries for the given PIN or VIN in the given time-range.

Lifetime total cumulative number of loads the machine has achieved.

  • PDC metric key used value.common.machine.load.count.total
  • PDC unit expected predefined.unit.NUMBER
get

Gets the latest available data points for CumulativeIdleNonoperatingHours timeseries for the given PIN or VIN in the default time-range (i.e. last 2 weeks).

Cumulative idle non-operating hours are the total hours when the engine is running, but the machine is not moving and the machine controls are not operated.

  • PDC metric key used value.common.machine.hours.idle.total
  • PDC unit expected predefined.unit.HOUR
get

Gets the latest available data points for CumulativeIdleNonoperatingHours timeseries for the given PIN or VIN in the given time-range.

Cumulative idle non-operating hours are the total hours when the engine is running, but the machine is not moving and the machine controls are not operated.

  • PDC metric key used value.common.machine.hours.idle.total
  • PDC unit expected predefined.unit.HOUR
get

Gets the latest available data points for CumulativeOperatingHours timeseries for the given PIN or VIN in the default time-range (i.e. last 2 weeks).

The current lifetime total cumulative operating hours of the machine.

  • PDC metric key used value.common.machine.hours.operation.total
  • PDC unit expected predefined.unit.HOUR
get

Gets the latest available data points for CumulativeOperatingHours timeseries for the given PIN or VIN in the given time-range.

The current lifetime total cumulative operating hours of the machine.

  • PDC metric key used value.common.machine.hours.operation.total
  • PDC unit expected predefined.unit.HOUR
get

Gets the latest available data points for CumulativeNonproductiveRegenerationHours timeseries for the given PIN or VIN in the default time-range (i.e. last 2 weeks).

The current lifetime total non-productive regeneration hours of the machine. Non-productive regeneration is the time when the machine is placed in a non-productive state to complete the regeneration process.

  • PDC metric key used value.common.engine.hours.regeneration.total
  • PDC unit expected predefined.unit.HOUR
get

Gets the latest available data points for CumulativeNonproductiveRegenerationHours timeseries for the given PIN or VIN in the given time-range.

The current lifetime total non-productive regeneration hours of the machine. Non-productive regeneration is the time when the machine is placed in a non-productive state to complete the regeneration process.

  • PDC metric key used value.common.engine.hours.regeneration.total
  • PDC unit expected predefined.unit.HOUR
get

Gets the latest available data points for CumulativePowerTakeOffHours timeseries for the given PIN or VIN in the default time-range (i.e. last 2 weeks).

Current lifetime total power take-off hours of the machine.

  • PDC metric key used value.common.machine.hours.pto.total
  • PDC unit expected predefined.unit.HOUR
get

Gets the latest available data points for CumulativePowerTakeOffHours timeseries for the given PIN or VIN in the given time-range.

Current lifetime total power take-off hours of the machine.

  • PDC metric key used value.common.machine.hours.pto.total
  • PDC unit expected predefined.unit.HOUR
get

Gets the latest available data points for DEFRemaining timeseries for the given PIN or VIN in the default time-range (i.e. last 2 weeks).

The percentage of DEF remaining in the DEF tank of the machine. Only valid "percentage" values are served (i.e. any values outside of [0.0 - 100.0] range are disregarded)

  • PDC metric key used value.common.engine.def.level
  • PDC unit expected predefined.unit.PERCENT
get

Gets the latest available data points for DEFRemaining timeseries for the given PIN or VIN in the given time-range.

The percentage of DEF remaining in the DEF tank of the machine. Only valid "percentage" values are served (i.e. any values outside of [0.0 - 100.0] range are disregarded)

  • PDC metric key used value.common.engine.def.level
  • PDC unit expected predefined.unit.PERCENT
get

Gets the latest available data points for EngineCondition timeseries for the given PIN or VIN in the default time-range (i.e. last 2 weeks).

Engine condition is the running state of the engine as of the specified date and time. This data type is Boolean with false (i.e. 0) indicating not running and true (i.e. 1) indicating running.

  • The EngineNumber and Running fields are populated using values that are stored separately, which has the following implications:

    • both underlying metrics have to be configured and present
    • the Running value drives the datetime in each datapoint
    • every datapoint's EngineNumber value is populated with the same, most recently reported one, irrespective of the requested time range
  • for EngineNumber

    • PDC metric key used value.common.engine.identification.serialnumber
    • PDC unit expected predefined.unit.TEXT
  • for EngineRunning

    • PDC metric key used value.common.engine.state
    • PDC unit expected predefined.unit.BITFIELD, converted to boolean 0=false, 1>=true
get

Gets the latest available data points for EngineCondition timeseries for the given PIN or VIN in the given time-range.

Engine condition is the running state of the engine as of the specified date and time. This data type is Boolean with false (i.e. 0) indicating not running and true (i.e. 1) indicating running.

  • The EngineNumber and Running fields are populated using values that are stored separately, which has the following implications:

    • both underlying metrics have to be configured and present
    • the Running value drives the datetime in each datapoint
    • every datapoint's EngineNumber value is populated with the same, most recently reported one, irrespective of the requested time range
  • for EngineNumber

    • PDC metric key used value.common.engine.identification.serialnumber
    • PDC unit expected predefined.unit.TEXT
  • for EngineRunning

    • PDC metric key used value.common.engine.state
    • PDC unit expected predefined.unit.BITFIELD, converted to boolean 0=false, 1>=true
get

Gets the latest available data points for Faults timeseries for the given PIN or VIN in the default time-range (i.e. last 2 weeks).

Also known as DiagnosticTroubleCodes, FaultCodes.

CodeDescription format is as follows: SPN: ${SPN description}; FMI: ${FMI description}; Source: ${fault source}; End: ${fault end time}

get

Gets the latest available data points for Faults timeseries for the given PIN or VIN in the given time-range.

Also known as DiagnosticTroubleCodes, FaultCodes.

CodeDescription format is as follows: SPN: ${SPN description}; FMI: ${FMI description}; Source: ${fault source}; End: ${fault end time}

get

Gets the latest available data points for FuelRemaining timeseries for the given PIN or VIN in the default time-range (i.e. last 2 weeks).

The percentage of fuel remaining in the fuel tank of the machine. Only valid "percentage" values are served (i.e. any values outside of [0.0 - 100.0] range are disregarded)

  • PDC metric key used value.common.engine.fuel.level
  • PDC unit expected predefined.unit.PERCENT
get

Gets the latest available data points for FuelRemaining timeseries for the given PIN or VIN in the given time-range.

The percentage of fuel remaining in the fuel tank of the machine. Only valid "percentage" values are served (i.e. any values outside of [0.0 - 100.0] range are disregarded)

  • PDC metric key used value.common.engine.fuel.level
  • PDC unit expected predefined.unit.PERCENT
get

Gets the latest available data points for Location timeseries for the given PIN or VIN in the default time-range (i.e. last 2 weeks).

The last known equipment location.

  • Latitude - from Geo dataset
  • Longitude - from Geo dataset
  • Altitude - from Geo dataset
  • unit expected predefined.unit.length.METER
get

Gets the latest available data points for Location timeseries for the given PIN or VIN in the given time-range.

The last known equipment location.

  • Latitude - from Geo dataset
  • Longitude - from Geo dataset
  • Altitude - from Geo dataset
  • unit expected predefined.unit.length.METER
get

Gets the latest available data points for PeakDailySpeed timeseries for the given PIN or VIN in the default time-range (i.e. last 2 weeks).

Peak daily speed is the highest achieved travel speed for this machine during the previous 24 h period. For timeseries each returned datapoint represents maximum speed during a 24h period ending at UTC midnight

  • PDC metric key used value.common.machine.speed
  • PDC unit expected predefined.unit.speed.KILOMETERS_PER_HOUR
get

Gets the latest available data points for PeakDailySpeed timeseries for the given PIN or VIN in the given time-range.

Peak daily speed is the highest achieved travel speed for this machine during the previous 24 h period. For timeseries each returned datapoint represents maximum speed during a 24h period ending at UTC midnight

  • PDC metric key used value.common.machine.speed
  • PDC unit expected predefined.unit.speed.KILOMETERS_PER_HOUR