Export Trip API

Explore how to export a trip with our Trip API

Export Trip

GET https://api.roam.ai/v2/trips/:id/export

Export the trip summary of the given trip id as gpx/json/csv/geojson file.

Path Parameters

Name	Type	Description
id*	String	Exports the trip summary with the given ID.

Query Parameters

Name	Type	Description
format*	String	Export type as csv/gpx/json/geojson eg: gpx

Headers

Name	Type	Description
Authorization*	String	Bearer <API-KEY>

200: OK Trip export success

{
    "code":200,
    "message":"trip_export_finished",
    "description":"The trip data is exported successfully for requested id.",
    "data": {
        "trip_id": "61dec6e206f8a019b2402c0b",
        "download_url": "https://roam-gpx-files.s3.amazonaws.com/61dec6e206f8a019b2402c0b.gpx"
    }
}

404: Not Found Object not found

{
  "code" : 404,
  "message" : "object_not_found",
  "description": "The requested object does not exist or already deleted.",
  "errors" : [ ]
}

Example

cURL

curl --location --request GET 'https://api.roam.ai/v2/trips/620f4fb7d79b3200007cd92c/export?format=gpx' \
--header 'Authorization: Bearer dfbbf5d5XXXXcb1166147b87c0544'