Skip to main content
Return the upload status, imported row count, and error if it failed. After finalizing, poll until status is succeeded or failed.

Signature

Method signature on client.datasets:

Parameters

string
required
Dataset upload ID with prefix dfu..

Returns

Promise<UploadJob> A dataset upload and its import status. After finalizing, poll until status is succeeded or failed.
UploadId
required
Dataset upload ID with prefix dfu..
"pending" | "running" | "succeeded" | "failed"
required
Upload state: pending before finalization, running while rows are imported, succeeded when complete, or failed after failure or cancellation.
string
required
Time the upload was started, as an ISO 8601 timestamp.
string | null
required
Failure or cancellation message, or null when no error is recorded.
object
required
Progress of the dataset import.

Errors

HTTP errors throw PotatoApiError. The endpoint documents these error responses: HTTP endpoint: GET /uploads/{uploadId}.