v4
latestOpenAPI 3.1.02026-07-31121440441.0 KBaiTaskBuilder
Get Dataset Import Status
Returns the current status of a V4 dataset import job. Each import job represents one ingestion operation and transitions through the following statuses:
- uninitialised — Presigned url requested, but not yet used
- processing — Datapoints received for ingestion, work underway
- queued — Datapoints received for ingestion, awaiting a previous import job to complete before processing can commence
Terminal statuses:
- complete — all records were accepted. accepted_count is populated.
- partial — some records were accepted and some rejected. accepted_count, rejected_count, and errors are populated. The accepted records are available for use.
- failed — extraction failed entirely (e.g. file could not be parsed). reason is populated. No records were ingested.
- pending_schema — the dataset has no schema set; upload is paused until a schema is defined.
Continue polling while the status is uninitialised, queued, or processing.
get/api/v1/data-collection/datasets/{dataset_id}/imports/{import_id}
Path parameters
dataset_idstring uuid required
The unique identifier of the dataset
import_idstring uuid required
The import job ID returned by GET /datasets/{dataset_id}/upload-url/{filename}
Headers
Authorizationstring required
The Prolific API uses API token to authenticate requests. You can create an API token directly from your settings.
Your API token does not have an expiry date and carries full permission, so be sure to keep them secure.
If your token is leaked, delete it and create a new one directly in the app.
In your requests add Authorization header with the value Token <your token>.
Response
Import job status