routes

Returns list of segments comprising a route. Authenticated user must have ownership of, or read access to, the device from which the route was uploaded.

get/v1/route/{routeName}/segments

Request

  • Base URL
    https://api.comma.ai
  • Auth
    HTTP bearer

Response

JSON array of segments

canonical_namestring required

Contains a dongle ID, timestamp of the beginning of the route, and segment number

numberinteger required

Segment number

canonical_route_namestring required

Contains a dongle ID and timestamp of the beginning of the route

dongle_idstring required

A unique 16-character hexadecimal string. Can represent a device or a user.

create_timeinteger required

Unix timestamp at which upload_url was first called for file in segment

start_time_utc_millisinteger required

Segment start time, milliseconds since epoch

end_time_utc_millisinteger required

Segment end time, milliseconds since epoch

urlstring required

Signed URL from which route.coords and JPEGs can be downloaded

lengthnumber required

Sum of distances between GPS points in miles

canboolean required

Segment contains CAN messages

hpgpsboolean required

Segment has ublox packets

radarboolean required

Segment contains radar tracks in CAN

devicetype3 | 6 | 7 required

Data source

  • 3 = eon
  • 6 = comma two
  • 7 = comma three
proc_log-1 | 0 | 10 | 20 | 30 | 40 | 50 required

Log file status

  • -1 = Not received
  • 0 = Upload URL sent
  • 10 = Received
  • 20 = Enqueued
  • 30 = Processing
  • 40 = Processed
  • 50 = Errored
proc_qlog-1 | 0 | 10 | 20 | 30 | 40 | 50 required

Log file status

  • -1 = Not received
  • 0 = Upload URL sent
  • 10 = Received
  • 20 = Enqueued
  • 30 = Processing
  • 40 = Processed
  • 50 = Errored
proc_camera-1 | 0 | 10 | 20 | 30 | 40 | 50 required

Log file status

  • -1 = Not received
  • 0 = Upload URL sent
  • 10 = Received
  • 20 = Enqueued
  • 30 = Processing
  • 40 = Processed
  • 50 = Errored
proc_dcamera-1 | 0 | 10 | 20 | 30 | 40 | 50 required

Log file status

  • -1 = Not received
  • 0 = Upload URL sent
  • 10 = Received
  • 20 = Enqueued
  • 30 = Processing
  • 40 = Processed
  • 50 = Errored
passiveboolean required

openpilot is running in passive mode

versionstring required

openpilot version

git_commitstring required

git commit hash

git_branchstring required

git branch

git_remotestring required

git remote url

git_dirtyboolean required

git working tree is dirty

Example response

[
  {
    "canonical_name": "1a2b3c4d5e6f7a8b|2019-01-01--00-00-00--0",
    "canonical_route_name": "1a2b3c4d5e6f7a8b|2019-01-01--00-00-00",
    "dongle_id": "1a2b3c4d5e6f7a8b"
  }
]

Changes