Skip to main content
Loading...

API docs by

Imports

The Imports endpoints are deprecated. Use the Recordings endpoints instead.

Imports are recordings that are available at a Primary Site.

Operations

List imports
deprecated

Request

This endpoint is deprecated. Use the list recordings endpoint instead.

Security
ApiKey(Required scopes: data.imports.list)
Query
deviceIdstring

ID of device associated with the exported data

filenamestring

Filename to match

startstring, (date-time)

Inclusive start of import time

endstring, (date-time)

Inclusive end of import time

dataStartstring, (date-time)

Inclusive start of message log time

dataEndstring, (date-time)

Inclusive end of message log time

sortBystring

Sort by a single field of the import type

Enum:"importId""deviceId""importTime""dataStart""dataEnd"
sortOrderstring

Sort order for the sortBy field

Enum:"asc""desc"
limitnumber, [ 0 .. 2000 ]

Maximum number of items to return

Default:2000
offsetinteger, >= 0

Number of items to skip before returning the results

Default:0
Python
from foxglove.client import Client

token = "<YOUR API TOKEN HERE>"
client = Client(token=token)

client.get_imports()

Responses

Success

Bodyapplication/json
Array [
idstringrequired

Opaque ID

orgIdstringrequired
deviceIdstring
deviceNamestring
filenamestringrequired
importTimestring, (date-time)required

Imported timestamp

startstring, (date-time)required

Message log time start of imported data

endstring, (date-time)required

Message log time end of imported data

inputTypestring

Supported input type: ROS 1 bag ("bag1") or MCAP v0.x ("mcap0") file

outputTypestring

Supported output type: ROS 1 bag ("bag1") or MCAP v0.x ("mcap0") file

inputSizenumber, (bigint)

Size in bytes of the uploaded file

totalOutputSizenumber, (bigint)

Size in bytes of the data after processing

datestring

Message log time start date in YYYYMMDD format e.g. 20170322

deletedboolean
importIdstringrequireddeprecated
]
Response
[
  {
    "id": "string",
    "importId": "string",
    "orgId": "string",
    "deviceId": "string",
    "deviceName": "string",
    "filename": "string",
    "importTime": "2019-08-24T14:15:22Z",
    "start": "2019-08-24T14:15:22Z",
    "end": "2019-08-24T14:15:22Z",
    "inputType": "string",
    "outputType": "string",
    "inputSize": 0,
    "totalOutputSize": 0,
    "date": "string",
    "deleted": true
  }
]