Get Dataset Import Status

GET

https://api.prolific.com/api/v1/data-collection/datasets/:dataset_id/imports/:import_id

GET

/api/v1/data-collection/datasets/:dataset_id/imports/:import_id

$ curl https://api.prolific.com/api/v1/data-collection/datasets/dataset_id/imports/import_id \
>      -H "Authorization: Token <token>" \
>      -H "Content-Type: application/json"

1 {
2   "dataset_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3   "import_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
4   "type": "file_upload",
5   "created_at": "2024-01-15T09:30:00Z",
6   "updated_at": "2024-01-15T10:00:00Z",
7   "status": "partial",
8   "filename": "participant_responses.csv",
9   "accepted_count": 150,
10   "rejected_count": 5,
11   "errors": [
12     {
13       "record_index": 23,
14       "field": "age",
15       "reason": "Value must be a positive integer"
16     },
17     {
18       "record_index": 47,
19       "field": "_raw",
20       "reason": "Malformed JSON in record"
21     }
22   ],
23   "reason": null
24 }

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.

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`.

Authentication

AuthorizationToken

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>.

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>`.

Path parameters

dataset_idstringRequiredformat: "uuid"

The unique identifier of the dataset

import_idstringRequiredformat: "uuid"

The import job ID returned by GET /datasets/{dataset_id}/upload-url/{filename}

Response

Import job status

dataset_idstringformat: "uuid"

The dataset this import job belongs to.

import_idstringformat: "uuid"

The unique identifier of the import job.

typeenum

The type of import. Currently always file_upload.

created_atdatetime

When the import job was created (ISO 8601, UTC).

updated_atdatetime

When the import job was last updated (ISO 8601, UTC).

statusenum

Current status of the import job.

filenamestring or null

The original filename supplied when the upload URL was requested.

accepted_countinteger>=0

Number of records successfully ingested. Present when status is complete or partial.

rejected_countinteger>=0

Number of records rejected. Present when status is partial.

errorslist of objects

Record-level validation errors. Present when status is partial.

reasonstring

Human-readable reason for failure. Present when status is failed.

Errors

4XX

Client Request Error

404

Not Found Error