List pending imports

Request

List the pending imports. These are in-progress import jobs for newly uploaded recordings.

Security

ApiKey(Required scopes: data.imports.pending.list)

Query

requestIdstring

A specific import request ID

keystring

The unique key optionally provided when importing

deviceIdstring

ID of device associated with the pending import

deviceNamestring

Name of device associated with the pending import

device.namestringdeprecated

Equivalent to deviceName, and ignored if deviceName is supplied

device.idstringdeprecated

Equivalent to deviceId, and ignored if deviceId is supplied

errorstringdeprecated

Deprecated. Use /import-errors instead.

siteBackfillJobIdstring

Filter to pending imports enqueued by this site backfill job (sbj_…).

filenamestring

Filename to exactly match

updatedSincestring, (date-time)

Filter pending imports updated since this time

showCompletedboolean

Include completed requests

Default:false

showQuarantinedboolean

Include quarantined requests

Default:false

siteIdstring

Filter response to imports at site with this ID

projectIdstring

Filter pending imports by project

sortBystring

Sort by a single field of the import type

Enum:"createdAt""deviceId""deviceName""device.name""device.id""error""importId""requestId""updatedAt"

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

Payload

// No request payload

Responses

Success

Bodyapplication/json

Array [

createdAtstring, (date-time)required

When the pending import was created

deviceIdstring

ID of device

deviceNamestring

Name of the device from which the import originated

errorstring

Error message, if status is "error"

filenamestringrequired

Filename of the import

importIdstring

ID of import; undefined until status is "complete"

orgIdstringrequired

ID of org to which the import belongs

pipelineStagestringrequired

stage in the import pipeline the import currently occupies

requestIdstringrequired

ID of the import request

projectIdstring

ID of the project to which the import belongs

siteIdstringrequired

ID of Primary Site where import will be stored

statusstring

Status of initiated import

Enum:"received""processing""ready for indexing""error""complete"

updatedAtstring, (date-time)required

When the pending import was last updated

quarantinedAtstring, (date-time)

When the pending import was quarantined

]

Response

[
  {
    "createdAt": "2019-08-24T14:15:22Z",
    "deviceId": "string",
    "deviceName": "string",
    "error": "string",
    "filename": "string",
    "importId": "string",
    "orgId": "string",
    "pipelineStage": "string",
    "requestId": "string",
    "projectId": "string",
    "siteId": "string",
    "status": "received",
    "updatedAt": "2019-08-24T14:15:22Z",
    "quarantinedAt": "2019-08-24T14:15:22Z"
  }
]