Get a Dataset

GET

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

GET

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

$ curl https://api.prolific.com/api/v1/data-collection/datasets/0192a3b5-e8f9-7a0b-1c2d-3e4f5a6b7c8d \
>      -H "Authorization: Token <token>" \
>      -H "Content-Type: application/json"

1 {
2   "id": "0192a3b5-e8f9-7a0b-1c2d-3e4f5a6b7c8d",
3   "name": "Customer Feedback Dataset",
4   "created_at": "2024-01-15T09:30:00Z",
5   "created_by": "65786062db3b35bcbeb07bcc",
6   "workspace_id": "6278acb09062db3b35bcbeb0",
7   "total_datapoint_count": 1500,
8   "schema_version": 3,
9   "status": "ERROR",
10   "filename": "customer_feedback_jan2024.csv",
11   "has_predetermined_grouping_id": true,
12   "schema": {
13     "strict": true,
14     "fields": {}
15   },
16   "imports": [
17     {
18       "dataset_id": "0192a3b5-e8f9-7a0b-1c2d-3e4f5a6b7c8d",
19       "import_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
20       "type": "file_upload",
21       "created_at": "2024-01-15T09:30:00Z",
22       "updated_at": "2024-01-15T10:00:00Z",
23       "status": "partial",
24       "filename": "customer_feedback_jan2024.csv",
25       "accepted_count": 1498,
26       "rejected_count": 2,
27       "errors": [
28         {
29           "record_index": 102,
30           "field": "feedback_text",
31           "reason": "Text field exceeds maximum length"
32         },
33         {
34           "record_index": 457,
35           "field": "_raw",
36           "reason": "Malformed JSON in record"
37         }
38       ],
39       "reason": ""
40     }
41   ]
42 }

Get a specific AI Task Builder dataset by its unique identifier.

For V4 datasets, the response includes the dataset schema (if one has been set) and an imports array listing all import jobs for this dataset.

For V3 datasets, the response includes status, filename, and has_predetermined_grouping_id instead.

Get a specific AI Task Builder dataset by its unique identifier. For **V4 datasets**, the response includes the dataset `schema` (if one has been set) and an `imports` array listing all import jobs for this dataset. For **V3 datasets**, the response includes `status`, `filename`, and `has_predetermined_grouping_id` instead.

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_idstringRequired

The unique identifier of the AI Task Builder dataset

Response

idstringformat: "uuid"

namestring

created_atdatetime

created_bystring

workspace_idstring

total_datapoint_countinteger>=0

schema_versionenum

Internal dataset version. 3 = legacy CSV/ZIP; 4 = structured schema with JSONL/CSV import tracking.

statusenum

Processing status. V3 datasets only. V4 datasets track status per import job via imports.

filenamestring or null

Filename of the uploaded data file. V3 datasets only.

has_predetermined_grouping_idboolean or null

Whether the dataset contains a META_TASK_GROUP_ID column. V3 datasets only.

schemaobject or null

The researcher-defined field schema for this dataset. V4 datasets only. null if no schema has been set yet.

importslist of objects or null

Import jobs for this dataset, most recent first. V4 datasets only. null for V3 datasets.

Errors

4XX

Client Request Error

404

Not Found Error