Roadtrippers Developer Hub

Welcome to the Roadtrippers Developer Hub. You'll find comprehensive guides and documentation to help you start working with Roadtrippers as quickly as possible, as well as support if you get stuck. Let's jump right in!

Imports

If you have a large amount of custom data about places that you would like to import, you can use the Imports API to load bulk files into the Boone database, with these Data Formats.

🚧

Account Setup Required

If you want to use these features, please contact your account manager or [email protected] to ensure that you have correct AWS permissions for S3 access.

/api/v2/imports/:import_id

Check the status of the import corresponding to a given import id.

Returns

status: 200

{
  "data": {
    "id": 8,
    "started_at": "2016-12-16T13:27:52.149Z",
    "completed_at": null,
    "files": [
      {
        "file_url": "s3://bucket/data_file.csv",
        "item_type": "places",
        "format": "json",
        "completed_at": nil,
        "error_text": nil,
        "completed_count": 0,
        "item_count": 10
      }
    ]
  }
}

/api/v2/imports

Create a new import.

Accepts

{
  "import": {
    "source_id": 8,
    "files": [
      {
        "file_url": "s3://bucket/data_file.json",
        "item_type": "places",
        "format": "json"
      }
    ]
  }
}

Returns

status: 200

{
  "data": {
    "id": 8,
    "started_at": "2016-12-16T13:27:52.149Z",
    "completed_at": null,
    "files": [
      {
        "file_url": "s3://bucket/data_file.json",
        "item_type": "places",
        "format": "json",
        "completed_at": nil,
        "error_text": nil,
        "completed_count": 0,
        "item_count": 10
      }
    ]
  }
}

📘

Complete documentation for import data formatting is available here.

/api/v2/imports

Return a list of your imports.

Returns

status: 200

{
  "data": [
    {
        "id": 8,
        "started_at": "2016-12-16T13:27:52.149Z",
        "completed_at": null,
        "files": [
        {
          "file_url": "s3://bucket/data_file.json",
          "item_type": "places",
          "format": "json",
          "completed_at": nil,
          "error_text": nil,
          "completed_count": 0,
          "item_count": 10
        }
      ]
    }
  ]
}

Data formats

import

NameTypeRequired?Description
idintegerNoDatabase ID of the import.
source_idintegerYesTarget source ID for the import.
started_atstringYesTime that the import was started.
completed_atstringNoTime that the import was completed, if it has been.
filesarray of file objectsYesFiles to be included in the import.

file

NameTypeRequired?Description
item_typestringYesType of data included in import. places and tags supported.
formatstringYesFormat of file to be imported. csv and json supported.
file_urlstringsYesFile to be included in the import.
completed_atstringNoTime that the file was completed, if it has been.
error_textstringNoError information if the file resulted in error.
completed_countintegerYesNumber of total places that have been processed.
item_countintegerYesNumber of total places that will be processed.

File formats

JSON Schema
CSV Requirements

Updated 2 years ago

Imports


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.