Retrieve ECM data

Retrieves engine computer module (ECM) data from vehicles. ECM data availability varies by vehicle, device, and cable configuration. Also, the organization must have a Fleet Tracking subscription to receive data from this endpoint.

SecuritybearerAuth
Request
query Parameters
deviceIdentifier
string or null

Can use either device serial number or deviceId. If no device, vehicle, or group is specified, returns data for all devices.

vehicleIdentifier
string or null

Can use either VIN, vehicleId, or vehicle name. If no device, vehicle, or group is specified, returns data for all vehicles.

groupIdentifier
string or null

Can use groupId, rootGroupId, or group name. If no device, vehicle, or group is specifid, returns data for all devices.

includeSubGroups
boolean

If true, all descendant groups under the specified group are included.

Example: includeSubGroups=false
offset
integer or null

Record to start with.

Example: offset=1500
limit
integer or null

Number of records to return.

Example: limit=100
startDate
string <date-time>

The startDate must be within the last 6 months. The startDate and endDate must be 24 hours of each other. ECM data is available for up to 7 days; DTC data is available for up to 6 months.

endDate
string <date-time>

The startDate and endDate must be within 24 hours of each other.

sort
string or null

Name of the property to sort on.

Example: sort=VehicleName
order
string or null

Sort direction.

Example: order=asc
Responses
200

Ok

400

Bad Request

401

Unauthorized.

403

Forbidden

404

Not Found

500

Internal Server Error.

get/v1/ecm
Request samples
Response samples
application/json
{
  • "data": [
    ],
  • "metadata": [
    ]
}