Get a recording

Request

Get details on a specific recording.

Security

ApiKey(Required scopes: recordings.list)

Path

keyOrIdstringrequired

Recording Key or ID

Payload

// No request payload

Responses

A Recording

Bodyapplication/json

idstringrequired

ID of the recording

projectIdstringrequired

The project ID that the recording belongs to

pathstringrequired

The filepath of the recording as it was originally provided to Foxglove. For recordings originated at the edge, this is the full path of the recording file in the edge controller store. For recordings uploaded directly to Foxglove, this is the filename query arg provided to /data/upload.

locationobject(RecordingObjectLocation)

The object-store location of a recording. Present only when the recording is indexed in a customer-managed bucket. Omitted for query-optimized sites, where the original object is not retained, and for recordings that have not yet been imported.

sizenumber, (bigint)required

The size of the recording file, in bytes

createdAtstring, (date-time)required

Timestamp when the recording file was added to Foxglove.

importedAtstring, (date-time)

Timestamp when the recording was imported to a primary site.

startstring, (date)required

The log time of the first message in the recording.

endstring, (date)required

The log time of the last message in the recording.

importStatusstring(RecordingImportStatus)required

The import status of recordings. Status will be one of:

none: The recording has not yet been imported, and import has not been requested.
pending: Foxglove has received a request to import this recording.
importing: The recording data is being processed for access via Foxglove.
failed: The recording data could not be imported.
complete: The contents of the recording are available for access via Foxglove.

Note: none and pending statuses are applicable only to recordings originating from an Edge Site or a device running Foxlet.

The set of importStatus values may expand in the future.

Enum:"none""pending""importing""failed""complete"

siteobject(PrimarySiteSummary)

The primary site for this recording.

edgeSiteobject(EdgeSiteSummary)

The edge site for this recording.

deviceobject(DeviceSummary)

ID and name of a device.

keystring

The unique, user-specified key assigned to a recording in MCAP metadata or during the upload process. This can be used to identify the recording, in addition to its id.

metadataArray of objects(RecordingMetadata)

The metadata records of the original MCAP file content

sessionIdstring

The ID of the session this recording belongs to.

Response

{
  "id": "string",
  "projectId": "string",
  "path": "string",
  "location": {
    "scheme": "gs",
    "path": "string",
    "bucket": "string",
    "azureStorageAccountName": "string"
  },
  "size": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "importedAt": "2019-08-24T14:15:22Z",
  "start": "2019-08-24",
  "end": "2019-08-24",
  "importStatus": "none",
  "site": {
    "id": "string",
    "name": "string",
    "indexingStrategy": "split-files"
  },
  "edgeSite": {
    "id": "string",
    "name": "string"
  },
  "device": {
    "id": "string",
    "name": "string"
  },
  "key": "string",
  "metadata": [
    { … }
  ],
  "sessionId": "string"
}