Skip to main content
GET
TypeScript SDK

Authorizations

Authorization
string
header
required

Enter ApiKey <your-api-key> in Authorization, including the ApiKey prefix. In cURL and Python samples, <api-key> means this full value. The TypeScript SDK adds the prefix for you.

Path Parameters

uploadId
string
required

Dataset upload ID with prefix dfu..

Pattern: ^dfu\.[0-9a-f]{8}-[0-9a-f]{4}-[7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

Response

Upload job status

A dataset upload and its import status. After finalizing, poll until status is succeeded or failed.

createdAt
string<date-time>
required

Time the upload was started, as an ISO 8601 timestamp.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
error
string | null
required

Failure or cancellation message, or null when no error is recorded.

id
string
required

Dataset upload ID with prefix dfu..

Pattern: ^dfu\.[0-9a-f]{8}-[0-9a-f]{4}-[7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
result
object
required

Progress of the dataset import.

status
enum<string>
required

Upload state: pending before finalization, running while rows are imported, succeeded when complete, or failed after failure or cancellation.

Available options:
pending,
running,
succeeded,
failed