Skip to main content

General Telemetry

Detailed description of API:

Version & Updates

VersionRevision DateRevision History
1.030th March 2026New Release

Overview

Telemetry API intends to provide the parameter information of the different parts of an equipment, which are collected from the modem in real time like AM53, PCM etc., which enables the users to understand the part parameters before or while creating the work order in DMS. The API set can be querried for telemetry data by the following methods:

  1. For a given equipment in one day.
  2. For a given equipment at a specific date and time
  3. For a given equipment in an aggregated format (hourly/day) between dates

The API provides information about geographical and the parametric values for all the critical parts of the equipment between the requested dates (as applicable) as a response. All the telemetry and its relevant data are extracted from the Geo Spatial System (GSS) of CNHi. Pictorial representation of the data flows below.

image.png

Pre-requisites

  • Dealer must use their Dealer Portal credentials to authorize API call
  • Each DMS provider will have a subscription_key assigned by CNHi team, please reach out to dlnadmssupport@cnh.com for assistance
  • Each Subscription key is unique to DMS and the environment it belongs to
  • User within Ownership Group has accepted CNH's Data Acknowledgement (if located in NAFTA)

Authentication

  • DMS will pass Basic auth in HTTP header with username/password
  • Each DMS provider will have a subscription_key assigned by CNHi team, please reach out to dlnadmssupport@cnh.com for assistance
  • The UserID and Password will be set up in the Dealer Portal by the Dealer uniquely for DMS access to interfaces
  • DEP API will require subscription_key in HTTP header to identify client

API Format

  • REST

The DEP takes care of the format transformations (as needed) to process the request and provide a response to the DMS system. New DMSs who are building this interface are recommended to the use the REST API for greater simplicity.

Connection Details

There are a total of 18 APIs for this interface, the two Unified APIs are an aggregate of the frequently used metrics for greater simplicity of having a single API call.

CNHi provides both a UAT/Staging and a Production interface for General Telemetry. VINs may be unavailable within staging environment, please reach out to CNHi for VIN examples (if necessary).

Unified API (7 Days)

Unified 7 day API returns an aggregate response of a predetermined (up to) a 7 day date range of the following APIs:

  • CumulativeOperatingHours
  • Location
  • MaxTransmissionOilTemp
  • MaxHydraulicOilTemp
  • MaxIntakeManifoldTemp
  • EngineStatus
  • FuelRemaining
  • MaxEngineCoolantTemp
  • MaxEngineOilTemp
  • DEFRemaining
  • Speed

Endpoints

EnvironmentURLAPIRequest Type
CERT/UAThttps://{base_url}/latamexternal/v1/fleet/equipment/{assetID}/UnifiedTelemetry/{startDate}/{endDate}RESTGET
Productionhttps://{base_url}/latamexternal/v1/fleet/equipment/{assetID}/UnifiedTelemetry/{startDate}/{endDate}RESTGET

Request Parameters

NameParameter TypeTypeIs RequiredDefault ValueComments
assetIDTemplate ParameterStringTrue-VIN Number
startDateTemplate ParameterDate TimeTrue-Start Date
endDateTemplate ParameterDate TimeTrue-End Date

Response Description

NameTypeDescription
TelemetryUnifiedMessages.Links.RelStringRelationship – The reference attribute describes the link. Paginated services shall include a collection of links that describe the current page (self), next page (next), previous page (prev), and last page (last).
TelemetryUnifiedMessages.Links.HrefStringHyperlink – the hypermedia reference URL (href) is a reference to another endpoint.
TelemetryUnifiedMessages.Metrics.DateTimeStringDate and Time Date and Time are expressed as: YYYY-MM-DDThh:mm:ssZ
TelemetryUnifiedMessages.Metrics.CumulativeOperatingHours.HourStringThe current total lifetime operating hours of the machine is expressed as the cumulative quantity of time during which the machine’s engine has been running. This is generally the value of the hour meter on the machine.
TelemetryUnifiedMessages.Metrics.Locations.LatitudeStringLatitude, GPS data. From pos_point Point object.
TelemetryUnifiedMessages.Metrics.Locations.LongitudeStringLongitude, GPS data. From pos_point Point object.
TelemetryUnifiedMessages.Metrics.Locations.AltitudeStringThe altitude is expressed as distance above mean sea level of the machine’s location. Altitude is reported in meters. This field is optional.
TelemetryUnifiedMessages.Metrics.Locations.AltitudeUnitsStringThe altitude of the location shall be expressed in meters. If altitude is included in the response, this field is mandatory. It shall have the value “meter”.
TelemetryUnifiedMessages.Metrics.MaxTransmissionOilTemp.TemperatureDecimalThe parameter indicates the maximum transmission oil temperature at date and time.
TelemetryUnifiedMessages.Metrics.MaxTransmissionOilTemp.UnitOfMeasureStringUnit of measure of transmission oil Temperature (Celsius).
TelemetryUnifiedMessages.Metrics.MaxHydraulicOilTemp.TemperatureDecimalThe parameter indicates the maximum hydraulic oil temperature at date and time.
TelemetryUnifiedMessages.Metrics.MaxHydraulicOilTemp.UnitOfMeasureStringUnit of measure of hydraulic oil Temperature (Celsius).
TelemetryUnifiedMessages.Metrics.MaxIntakeManifoldTemp.TemperatureDecimalThe parameter indicates the maximum Intake Manifold temperature at particular date and time.
TelemetryUnifiedMessages.Metrics.MaxIntakeManifoldTemp.UnitOfMeasureStringUnit of measure of hydraulic oil Temperature (Celsius).
TelemetryUnifiedMessages.Metrics.EngineStatus .RunningStringThe parameter indicates Engine running status at particular date and time.
TelemetryUnifiedMessages.Metrics.FuelRemaining.FuelStringThe parameter indicates fuel remaining percentage.
TelemetryUnifiedMessages.Metrics.MaxEngineCoolantTemp.TemperatureDecimalThe parameter indicates the maximum Engine Coolant temperature at particular date and time.
TelemetryUnifiedMessages.Metrics.MaxEngineCoolantTemp.UnitOfMeasureStringUnit of measure of engine coolant Temperature (Celsius).
TelemetryUnifiedMessages.Metrics.maxEngineOilTemp.TemperatureDecimalThe parameter indicates the maximum Engine Oil temperature at particular date and time.
TelemetryUnifiedMessages.Metrics.maxEngineOilTemp.UnitOfMeasureStringUnit of measure of engine oil Temperature (Celsius).
TelemetryUnifiedMessages.Metrics.DEFRemaining.PercentDecimalPercentage of DEF Remaining at particular Date and Time.
TelemetryUnifiedMessages.Metrics.Speed.SpeedUnitsStringUnit of measure of Speed of the vehicle (KM/H)
TelemetryUnifiedMessages.Metrics.Speed.SpeedDecimalThe parameter indicates speed of the vehicle at Date and Time.

Sample Response

Download Unified API (7 Days) API Response

Unified API (Last 24 Hours)

Unified 24 Hour API returns an aggregate response of the last 24 hours of the the following APIs:

  • CumulativeOperatingHours
  • Location
  • MaxTransmissionOilTemp
  • MaxHydraulicOilTemp
  • MaxIntakeManifoldTemp
  • EngineStatus
  • FuelRemaining
  • MaxEngineCoolantTemp
  • MaxEngineOilTemp
  • DEFRemaining
  • Speed

LATAM Endpoints

EnvironmentURLAPIRequest Type
CERT/UAThttps://{base_url}/latamexternal/v1/fleet/equipment/latest/{assetID}/unified24telemetryRESTGET
Productionhttps://{base_url}/latamexternal/v1/fleet/equipment/latest/{assetID}/unified24telemetryRESTGET

Request Parameters

NameInputTypeIs RequiredComments
assetIDTemplate ParameterStringTrueVIN

Response Description

NameTypeDescription
TelemetryUnifiedMessages.Links.RelStringRelationship – The reference attribute describes the link. Paginated services shall include a collection of links that describe the current page (self), next page (next), previous page (prev), and last page (last).
TelemetryUnifiedMessages.Links.HrefStringHyperlink – the hypermedia reference URL (href) is a reference to another endpoint.
TelemetryUnifiedMessages.Metrics.DateTimeStringDate and Time Date and Time are expressed as: YYYY-MM-DDThh:mm:ssZ
TelemetryUnifiedMessages.Metrics.CumulativeOperatingHours.HourStringThe current total lifetime operating hours of the machine is expressed as the cumulative quantity of time during which the machine’s engine has been running. This is generally the value of the hour meter on the machine.
TelemetryUnifiedMessages.Metrics.Locations.LatitudeStringLatitude, GPS data. From pos_point Point object.
TelemetryUnifiedMessages.Metrics.Locations.LongitudeStringLongitude, GPS data. From pos_point Point object.
TelemetryUnifiedMessages.Metrics.Locations.AltitudeStringThe altitude is expressed as distance above mean sea level of the machine’s location. Altitude is reported in meters. This field is optional.
TelemetryUnifiedMessages.Metrics.Locations.AltitudeUnitsStringThe altitude of the location shall be expressed in meters. If altitude is included in the response, this field is mandatory. It shall have the value “meter”.
TelemetryUnifiedMessages.Metrics.MaxTransmissionOilTemp.TemperatureDecimalThe parameter indicates the maximum transmission oil temperature at date and time.
TelemetryUnifiedMessages.Metrics.MaxTransmissionOilTemp.UnitOfMeasureStringUnit of measure of transmission oil Temperature (Celsius).
TelemetryUnifiedMessages.Metrics.MaxHydraulicOilTemp.TemperatureDecimalThe parameter indicates the maximum hydraulic oil temperature at date and time.
TelemetryUnifiedMessages.Metrics.MaxHydraulicOilTemp.UnitOfMeasureStringUnit of measure of hydraulic oil Temperature (Celsius).
TelemetryUnifiedMessages.Metrics.MaxIntakeManifoldTemp.TemperatureDecimalThe parameter indicates the maximum Intake Manifold temperature at particular date and time.
TelemetryUnifiedMessages.Metrics.MaxIntakeManifoldTemp.UnitOfMeasureStringUnit of measure of hydraulic oil Temperature (Celsius).
TelemetryUnifiedMessages.Metrics.EngineStatus.RunningStringThe parameter indicates Engine running status at particular date and time.
TelemetryUnifiedMessages.Metrics.FuelRemaining.FuelStringThe parameter indicates fuel remaining percentage.
TelemetryUnifiedMessages.Metrics.MaxEngineCoolantTemp.TemperatureDecimalThe parameter indicates the maximum Engine Coolant temperature at particular date and time.
TelemetryUnifiedMessages.Metrics.MaxEngineCoolantTemp.UnitOfMeasureStringUnit of measure of engine coolant Temperature (Celsius).
TelemetryUnifiedMessages.Metrics.maxEngineOilTemp.TemperatureDecimalThe parameter indicates the maximum Engine Oil temperature at particular date and time.
TelemetryUnifiedMessages.Metrics.maxEngineOilTemp.UnitOfMeasureStringUnit of measure of engine oil Temperature (Celsius).
TelemetryUnifiedMessages.Metrics.DEFRemaining.PercentDecimalPercentage of DEF Remaining at particular Date and Time.
TelemetryUnifiedMessages.Metrics.Speed.SpeedUnitsStringUnit of measure of Speed of the vehicle (KM/H)
TelemetryUnifiedMessages.Metrics.Speed.SpeedDecimalThe parameter indicates speed of the vehicle at Date and Time.

Sample Response

Download Unified API (Last 24 Hours) API Response

Response Codes

Status CodeMessageReason
200API request successSuccesful connection to API and backend
500Internal Server ErrorUnsuccessful conection to API or backend
401Access denied due to invalid credentials!Bad credentials, check username and password
404The requested VIN is not a connected vehicle, please check the VIN.Vehicle does not have modem or telematic equipment.
404VIN is not available, please check the VIN.Incorrect VIN input.
404No data found, Telematic subscription has expired for this VIN.Telematic subscription for the VIN has expired.
404Vehicle data currently not available due to Telematic connectivity issue.Vehicle is unable to connect/transmit telematic data.
404The requested VIN is inactive or has never been activated, please check Telematic subscription.Telematic subscription is either inactive or not activated.
404The requested VIN or Telematic data could not be found but may be available in the future, please check the VIN and Telematic subscription.Service is down and/or trouble with backend.