--- title: "Telemetry of vehicle" method: GET path: "/fleets/{fid}/vehicles/{vid}/telemetry" tags: ["Vehicles"] --- # Telemetry of vehicle `GET /fleets/{fid}/vehicles/{vid}/telemetry` ## Request - Base URL: `https://api-cert.groupe-psa.com/connectedcar/v3` - URL: `https://api-cert.groupe-psa.com/connectedcar/v3/fleets/{fid}/vehicles/{vid}/telemetry` - Auth: HTTP basic and API key in query parameter `client_id` - TypeScript: (a function with typed inputs; its response is checked against the schema) Returns the latest Telemetry messages that occurred during a selective timestamp-ranges and bounded by an index range. ## Path parameters - `fid` string, required - `vid` string, required ## Query parameters - `profile` 'fleet' | 'endUser' - `timestamps` string[] - `indexRange` string: Range index used to express the first (offset) and the last results index to retrieve. With the respect to the regex pattern '\d+(-\d*)?', the start of range is mandatory (use 0 for default). *Example:* * '0-9' : start=0, end=9 ==> offset=0 and number of items=10 * '5-' : start =5, no end ==> start at 5th to the end results. - `pageSize` integer - `pageToken` string - `type` string[] - `extension` string[] ## Response `200` Telemetry response - Telemetries - `_links` TabLinks, required: [HAL](https://en.wikipedia.org/wiki/Hypertext_Application_Language#Convention) (Hypertext Application Language) link collection - `self` Link, required: A Link Object as defined by [JSONHAL#Link Object](https://tools.ietf.org/html/draft-kelly-json-hal-08#section-5). - `href` string, required: URL format follows [RFC 3986](https://tools.ietf.org/html/rfc3986) and usually looks like this ` scheme://host[:port][/Path] ` - `templated` boolean: SHOULD be true when the Link Object's "href" property is an [URI Template](https://tools.ietf.org/html/rfc6570) - `type` string: a hint to indicate the media type expected when dereferencing the target resource. - `deprecation` string: indicates that the link is to be deprecated (i.e. removed) at a future date. Its value is a URL that SHOULD provide further information about the deprecation. - `name` string - `title` string: Its value is a string and is intended for labelling the link with a human-readable identifier (as defined by [RFC5988](https://tools.ietf.org/html/rfc5988)). - `profile` string: Its value is a string and is intended for indicating the language of the target resource (as defined by [RFC5988]). - `hreflang` string: Its value is a string which is a URI that hints about the profile (as defined by [I-D.wilde-profile-link](https://tools.ietf.org/html/draft-kelly-json-hal-08#ref-I-D.wilde-profile-link)) of the target resource. - `first` Link, required: A Link Object as defined by [JSONHAL#Link Object](https://tools.ietf.org/html/draft-kelly-json-hal-08#section-5). - `href` string, required: URL format follows [RFC 3986](https://tools.ietf.org/html/rfc3986) and usually looks like this ` scheme://host[:port][/Path] ` - `templated` boolean: SHOULD be true when the Link Object's "href" property is an [URI Template](https://tools.ietf.org/html/rfc6570) - `type` string: a hint to indicate the media type expected when dereferencing the target resource. - `deprecation` string: indicates that the link is to be deprecated (i.e. removed) at a future date. Its value is a URL that SHOULD provide further information about the deprecation. - `name` string - `title` string: Its value is a string and is intended for labelling the link with a human-readable identifier (as defined by [RFC5988](https://tools.ietf.org/html/rfc5988)). - `profile` string: Its value is a string and is intended for indicating the language of the target resource (as defined by [RFC5988]). - `hreflang` string: Its value is a string which is a URI that hints about the profile (as defined by [I-D.wilde-profile-link](https://tools.ietf.org/html/draft-kelly-json-hal-08#ref-I-D.wilde-profile-link)) of the target resource. - `next` Link: A Link Object as defined by [JSONHAL#Link Object](https://tools.ietf.org/html/draft-kelly-json-hal-08#section-5). - `href` string, required: URL format follows [RFC 3986](https://tools.ietf.org/html/rfc3986) and usually looks like this ` scheme://host[:port][/Path] ` - `templated` boolean: SHOULD be true when the Link Object's "href" property is an [URI Template](https://tools.ietf.org/html/rfc6570) - `type` string: a hint to indicate the media type expected when dereferencing the target resource. - `deprecation` string: indicates that the link is to be deprecated (i.e. removed) at a future date. Its value is a URL that SHOULD provide further information about the deprecation. - `name` string - `title` string: Its value is a string and is intended for labelling the link with a human-readable identifier (as defined by [RFC5988](https://tools.ietf.org/html/rfc5988)). - `profile` string: Its value is a string and is intended for indicating the language of the target resource (as defined by [RFC5988]). - `hreflang` string: Its value is a string which is a URI that hints about the profile (as defined by [I-D.wilde-profile-link](https://tools.ietf.org/html/draft-kelly-json-hal-08#ref-I-D.wilde-profile-link)) of the target resource. - `prev` Link: A Link Object as defined by [JSONHAL#Link Object](https://tools.ietf.org/html/draft-kelly-json-hal-08#section-5). - `href` string, required: URL format follows [RFC 3986](https://tools.ietf.org/html/rfc3986) and usually looks like this ` scheme://host[:port][/Path] ` - `templated` boolean: SHOULD be true when the Link Object's "href" property is an [URI Template](https://tools.ietf.org/html/rfc6570) - `type` string: a hint to indicate the media type expected when dereferencing the target resource. - `deprecation` string: indicates that the link is to be deprecated (i.e. removed) at a future date. Its value is a URL that SHOULD provide further information about the deprecation. - `name` string - `title` string: Its value is a string and is intended for labelling the link with a human-readable identifier (as defined by [RFC5988](https://tools.ietf.org/html/rfc5988)). - `profile` string: Its value is a string and is intended for indicating the language of the target resource (as defined by [RFC5988]). - `hreflang` string: Its value is a string which is a URI that hints about the profile (as defined by [I-D.wilde-profile-link](https://tools.ietf.org/html/draft-kelly-json-hal-08#ref-I-D.wilde-profile-link)) of the target resource. - `last` Link: A Link Object as defined by [JSONHAL#Link Object](https://tools.ietf.org/html/draft-kelly-json-hal-08#section-5). - `href` string, required: URL format follows [RFC 3986](https://tools.ietf.org/html/rfc3986) and usually looks like this ` scheme://host[:port][/Path] ` - `templated` boolean: SHOULD be true when the Link Object's "href" property is an [URI Template](https://tools.ietf.org/html/rfc6570) - `type` string: a hint to indicate the media type expected when dereferencing the target resource. - `deprecation` string: indicates that the link is to be deprecated (i.e. removed) at a future date. Its value is a URL that SHOULD provide further information about the deprecation. - `name` string - `title` string: Its value is a string and is intended for labelling the link with a human-readable identifier (as defined by [RFC5988](https://tools.ietf.org/html/rfc5988)). - `profile` string: Its value is a string and is intended for indicating the language of the target resource (as defined by [RFC5988]). - `hreflang` string: Its value is a string which is a URI that hints about the profile (as defined by [I-D.wilde-profile-link](https://tools.ietf.org/html/draft-kelly-json-hal-08#ref-I-D.wilde-profile-link)) of the target resource. - `total` integer, required - `totalPage` integer, required - `currentPage` integer, required - `_embedded` object, required - `telemetries` Telemetry[] - `createdAt` string, date-time, required: Date when the resource has been created. - `_links` object, required - `self` Link, required: A Link Object as defined by [JSONHAL#Link Object](https://tools.ietf.org/html/draft-kelly-json-hal-08#section-5). - `href` string, required: URL format follows [RFC 3986](https://tools.ietf.org/html/rfc3986) and usually looks like this ` scheme://host[:port][/Path] ` - `templated` boolean: SHOULD be true when the Link Object's "href" property is an [URI Template](https://tools.ietf.org/html/rfc6570) - `type` string: a hint to indicate the media type expected when dereferencing the target resource. - `deprecation` string: indicates that the link is to be deprecated (i.e. removed) at a future date. Its value is a URL that SHOULD provide further information about the deprecation. - `name` string - `title` string: Its value is a string and is intended for labelling the link with a human-readable identifier (as defined by [RFC5988](https://tools.ietf.org/html/rfc5988)). - `profile` string: Its value is a string and is intended for indicating the language of the target resource (as defined by [RFC5988]). - `hreflang` string: Its value is a string which is a URI that hints about the profile (as defined by [I-D.wilde-profile-link](https://tools.ietf.org/html/draft-kelly-json-hal-08#ref-I-D.wilde-profile-link)) of the target resource. - `vehicle` Link: A Link Object as defined by [JSONHAL#Link Object](https://tools.ietf.org/html/draft-kelly-json-hal-08#section-5). - `href` string, required: URL format follows [RFC 3986](https://tools.ietf.org/html/rfc3986) and usually looks like this ` scheme://host[:port][/Path] ` - `templated` boolean: SHOULD be true when the Link Object's "href" property is an [URI Template](https://tools.ietf.org/html/rfc6570) - `type` string: a hint to indicate the media type expected when dereferencing the target resource. - `deprecation` string: indicates that the link is to be deprecated (i.e. removed) at a future date. Its value is a URL that SHOULD provide further information about the deprecation. - `name` string - `title` string: Its value is a string and is intended for labelling the link with a human-readable identifier (as defined by [RFC5988](https://tools.ietf.org/html/rfc5988)). - `profile` string: Its value is a string and is intended for indicating the language of the target resource (as defined by [RFC5988]). - `hreflang` string: Its value is a string which is a URI that hints about the profile (as defined by [I-D.wilde-profile-link](https://tools.ietf.org/html/draft-kelly-json-hal-08#ref-I-D.wilde-profile-link)) of the target resource. - `trip` Link: A Link Object as defined by [JSONHAL#Link Object](https://tools.ietf.org/html/draft-kelly-json-hal-08#section-5). - `href` string, required: URL format follows [RFC 3986](https://tools.ietf.org/html/rfc3986) and usually looks like this ` scheme://host[:port][/Path] ` - `templated` boolean: SHOULD be true when the Link Object's "href" property is an [URI Template](https://tools.ietf.org/html/rfc6570) - `type` string: a hint to indicate the media type expected when dereferencing the target resource. - `deprecation` string: indicates that the link is to be deprecated (i.e. removed) at a future date. Its value is a URL that SHOULD provide further information about the deprecation. - `name` string - `title` string: Its value is a string and is intended for labelling the link with a human-readable identifier (as defined by [RFC5988](https://tools.ietf.org/html/rfc5988)). - `profile` string: Its value is a string and is intended for indicating the language of the target resource (as defined by [RFC5988]). - `hreflang` string: Its value is a string which is a URI that hints about the profile (as defined by [I-D.wilde-profile-link](https://tools.ietf.org/html/draft-kelly-json-hal-08#ref-I-D.wilde-profile-link)) of the target resource. - `privacy` PrivacyBase - `state` 'None' | 'Geolocation' | 'Full' - `vehicle` object - `engines` EngineBase[] - `type` 'Thermic' | 'Electric' - `speed` number, float: Engine's speed in RPM - `gmpStatus` 'NotRunning' | 'Starting' | 'Running' | 'Stopping' | 'Stopped' - `extension` object - `thermic` object - … - `energies` EnergyBase[] - `type` 'Fuel' | 'Electric', required: Energy type present on the vehicle. - `subType` 'FossilEnergy' | 'ElectricEnergy' | 'Hydrogen': Energy subtype. This field is not mandatory and therefore if it is not present, it means that the resource consumer should only process the primary energy type. The enumeration of the subtypes is not exhaustive and may contain more elements depending on the evolution of the vehicles. The consumer of the data must take this constraint into account. The Fossil and Electric energy subtypes are only used to populate this subtype for the default Fuel and Eletric types. * Electric and hydrogen vehicles energy types are considered as low emission energies whereas fuel(fossil) is associated to thermic energy - `level` number, float: Percentage of remaining energy (Fuel or electric) level. Expressed with a precision of 0.1%. - `autonomy` integer: Vehicle autonomy expressed in km for this energy class. - `extension` object - `fuel` object: Specific fuel energy properties. - … - `electric` object: Specific electric energy parameters. - … - `transmission` Transmission - `gearbox` object - `mode` object - … - `ratio` 'Ratio1' | 'Ratio2' | 'Ratio3' | 'Ratio4' | 'Ratio5' | 'Ratio6' | 'Ratio7' | 'Ratio8' | 'Neutral' | 'Reverse': Current gear-box ratio. - `powertrain` PowertrainBase - `status` 'NotRunning' | 'Starting' | 'Running' | 'Stopping' | 'Stopped': Status of the powertrain - `adas` Adas - `parkAssist` object - `front` string[] - `rear` string[] - `accr` 'Activated' | 'Fault' | 'Hold' | 'HoldWithOverSpeeding' | 'Off' | 'OverSpeedingByPedalPress' | 'StandBy': Adaptive Cruise Control Regulation - `lvv` boolean - `rvv` 'Off' | 'NoBestFit' | 'BestFitInProgress' | 'BestFitMax' | 'BestFitMin' | 'BestFitDeactivated' | 'AutoDeactivated' | 'OverflowSpeedConsign' | 'LackOfVisibilityRadar' | 'LearningRadar' | 'Deactivated' | 'LimitSetting': Advanced Speed Regulator - `aebs` 'Off' | 'Fixed' | 'OnFlashing': Advanced Emergency Braking System - `afil` 'FlashingFault' | 'FlashingWarning' | 'Off' | 'OnFixed': Lane Departure Warning System - `artiv` 'NotSelected' | 'Selected' | 'Unavailable': Respect of inter vehicle time assist (ARTIV) - `bsm` 'Active' | 'Inactive' | 'Disabled' | 'Fault': Blind Spot Monitoring - `esp` boolean: Electronic Stability Program - `abs` boolean: Anti-lock braking system - `fse` boolean: Electric brake service - `sli` integer: Speed Limit Information (expressed in km/h) - `rlka` 'Authorized' | 'CorrectionInProgress' | 'NotAuthorized' | 'NotSelected': Right Lane Keeping Assist - `llka` 'Authorized' | 'CorrectionInProgress' | 'NotAuthorized' | 'NotSelected': Left Lane Keeping Assist - `rgi` 'None' | 'Up' | 'Down' | 'UpDown': Recommended gear indicator - `lighting` LightingBase: Depricated lighting system model. Use LightingSystem instead. - `turn` string[] - `light` string[] - `status` string[] - `lightingSystem` LightingSystemBase: Expresses the Directional, Fog and Position vehicle lights. - `turn` object[]: Expresses all light, direction (```Left```, ```Right``` ), position (```Front```, ```Rear``` ) and status (```Off```, ```On```) for a category. - `direction` 'Left' | 'Right' - `position` 'Front' | 'Rear' - `status` 'Off' | 'On' - `fog` object[]: Expresses all light, direction (```Left```, ```Right``` ), position (```Front```, ```Rear``` ) and status (```Off```, ```On```) for a category. - `direction` 'Left' | 'Right' - `position` 'Front' | 'Rear' - `status` 'Off' | 'On' - `ignition` IgnitionBase - `type` 'Stop' | 'StartUp' | 'Start', required - `doorsState` DoorsStateBase - `lockedStates` string[]: List of all known doors' states - `opening` object[] - `identifier` 'Driver' | 'Passenger' | 'RearLeft' | 'RearRight' | 'Trunk' | 'RearWindow' | 'RoofWindow' - `state` 'Open' | 'Closed' - `battery` BatteryBase: Describe the car (with combustion engine) battery status. - `voltage` number, float: Auxiliary battery (12V) state of health in % - `safety` BaseSafety - `beltStatus` BeltStatus[] - `belt` 'Normal' | 'Omission': Belt status. - `id` 'Driver' | 'Passenger': Seat identifier. - `autoECallTriggering` 'NotDetected' | 'Detected' | 'ShockDetectionUnabled' - `wipingBlades` WipingBladesState - `createdAt` string, date-time, required: Date when the resource has been created. - `active` boolean: Either active (true) or not (false). - `speed` 'High' | 'Low': Wiping speed. This field is present only if active field is set to true. - `odometer` object - `mileage` number, float: Vehicle mileage expressed in KM. - `alarm` BaseAlarm: Describe a vehicle alarm status and trigger. - `status` BaseAlarmStatus: Describe a vehicle alarm status. - `activation` 'Inactive' | 'Active', required: Define whether the vehicle alarm is active or not. - `trigger` BaseAlarmTrigger: Describe a vehicle alarm trigger. - `type` 'NoBreakIn' | 'FrontRightDoorBreakIn' | 'FrontLeftDoorBreakIn' | 'RearRightFrontDoorBreakIn' | 'RearLeftFrontDoorBreakIn' | 'HoodDoorBreakIn' | 'TrunkDoorBreakIn' | 'BackliteDoorBreakIn' | 'RoofBreakIn' | 'VolumetricBreakIn' | 'VehicleLifting' | 'ElectricalsystemBreakIn' | 'KeyLearning' | 'UnauthenticatedStartup', required: Define the vehicle break-in type. - `position` object: The position (last vehicle known one) where the alarm triggered. - … - `startAt` string, date-time, required: Time when the alarm triggering started. - `kinetic` BasicKinetic: Everything related to the movement of the vehicle. Speed, acceleration.. - `acceleration` number, float: Vehicle acceleration (expressed in m/s²) - `speed` number, float: Vehicle speed (expressed in km/h) - `moving` boolean - `drivingBehavior` DrivingBehaviorBase - `mode` 'Normal' | 'Sport' | 'Comfort' | 'Eco' | 'Sand' | 'Mud' | 'Snow' | 'ZEV' | 'Hybrid' | 'ZEVEco' | 'HybridEco' | 'EcoPlus' | 'eAWD' | '4AWD' | 'ReinforcedLoad': Driving mode by driver selection - `environment` EnvironmentBase - `luminosity` LuminosityBase - `day` boolean - `air` AirBase - `temp` number, float: Outside air temperature in Celsius degrees - `_embedded` object - `extension` TelemetryExtension: Additional data set for telemetry. - `location` PositionBase - `type` 'Feature', required - `geometry` Point, required: This object expresses a GeoJSON Point as specified by [rfc7946](https://tools.ietf.org/html/rfc7946#section-3.1.2). - … - `properties` object, required - … - `maintenance` MaintenanceBase: Expresses next Maintenance details. Such as number of days and the mileage until the next Maintenance. The value is negative if the next maintenance (day or mileage) is already passed. At least one of the following maintenance information will be provided. - `vin` string, required: Identifier of a vehicle. **Set when retrieving resource in batch mode**. - `daysBeforeMaintenance` integer - `mileageBeforeMaintenance` number, float ## Other responses - `default` (unresolved $ref) --- [API](https://skmtc.dev/groupe-psa/apis/groupe-psa-connected-car-b2b-api.md) - [All operations](https://skmtc.dev/groupe-psa/apis/groupe-psa-connected-car-b2b-api/llms.txt) - [OpenAPI document](https://skmtc.dev/groupe-psa/apis/groupe-psa-connected-car-b2b-api/revisions/023ff3e3fe51?raw)