Get Route Telemetry

Returns paginated segment-level physics data (grade, curvature, fuel burn) for a completed route.

GET /v1/routes/{route_id}/telemetry

Get Route Telemetry

cURL

curl --request GET \
  --url http://localhost:8000/v1/routes/{route_id}/telemetry

200

Example

{
  "routeId": "<string>",
  "computedAt": "2023-11-07T05:31:56Z",
  "vehicleSpec": {},
  "summary": {
    "totalFuelBurnLiters": 123,
    "totalGradeGainMeters": 123,
    "totalGradeLossMeters": 123,
    "maxGradePercent": 123,
    "averageCurvatureDegreesPerKm": 123,
    "schoolZoneCount": 0,
    "residentialSegmentCount": 0
  },
  "segments": [
    {
      "index": 123,
      "startLocation": {
        "latLng": {
          "latitude": 41.878,
          "longitude": -87.636
        }
      },
      "endLocation": {
        "latLng": {
          "latitude": 41.878,
          "longitude": -87.636
        }
      },
      "distanceMeters": 123,
      "durationSeconds": 123,
      "gradePercent": 123,
      "curvatureDegreesPerKm": 123,
      "fuelBurnLiters": 123,
      "zoneFlags": [
        "<string>"
      ],
      "speedLimitKmh": 123,
      "roadClass": "<string>"
    }
  ],
  "hasMore": false,
  "nextCursor": "<string>"
}

Telemetry is only available for routes with status: "complete". Requesting telemetry for a processing route returns a 404 with a helpful error message.

Path Parameters

route_id · string · required

The unique route resource ID

Example:

"route_01HYX3MPK5XJQJG0NB0PRSDVWC"

Query Parameters

cursor · integer · default: 0

Pagination cursor (segment index offset). Defaults to 0.

Required range: x >= 0

limit · integer · default: 50

Maximum number of segments to return per page. Defaults to 50, max 200.

Required range: 1 <= x <= 200

Response

200

application/json

Telemetry data for the route

Full telemetry response with summary and per-segment data

routeId · string · required

Associated route ID

computedAt · string<date-time> · required

When telemetry was computed

vehicleSpec · object · required

Resolved vehicle specification used for computation

summary · object · required

Aggregated telemetry summary for the entire route

Show child attributes

segments · object[] · required

Paginated segment telemetry data

Show child attributes

hasMore · boolean · default: false

Whether more segments are available

nextCursor · string | null

Cursor for the next page of segments