latestOpenAPI 3.1.02026-08-0450121252.8 KB

bcb08bba814d

Vehicle Telemetry

Get Vehicle Telemetry

Retrieve telemetry data for the specified vehicle. The telemetry data provides essential information about the vehicle's status and performance.

Parameters:

  • vehicle_id: The unique identifier (ID) of the vehicle to retrieve telemetry data for.

Returns:

  • Telemetry data for the vehicle.

Telemetry Information returned might include:

  • Odometer: The total distance traveled by the vehicle, recorded in kilometers. The timestamp indicates when the odometer reading was taken.
  • Location: The current latitude and longitude coordinates of the vehicle's position on Earth's surface. The timestamp indicates when the location reading was captured.
  • Elevation: The vehicle's altitude above sea level, measured in meters. The timestamp shows when the elevation reading was recorded.
  • State of Charge: The battery's state of charge, expressed as a percentage. The timestamp indicates when the charge level was last updated.
  • Charging State: Indicates whether the vehicle is actively charging or not. The timestamp reveals the time of the charging state observation.
  • Range: The estimated driving range of the vehicle on its current battery charge, provided in kilometers. The timestamp shows when the range reading was taken.

Note:

  • The vehicle_id should correspond to a valid and existing vehicle identifier.

Possible Codes in Error Response (see Errors for error response schema and meaning of codes):

  • AUTHENTICATION_ERROR
  • REQUEST_VALIDATION_ERROR
  • RESOURCE_NOT_FOUND
  • SERVER_ERROR
get/v1/vehicles/{vehicle_id}/telemetry

Path parameters

vehicle_idstring required

Unique internal identifier for the vehicle.

Unique internal identifier for the vehicle.

Response

Successful Response

idstring required