Get Batch Sync Status | Prolific API

Returns the current status of a batch sync job created by POST /batches/{batch_id}/sync.

A sync job transitions through the following statuses:

queued — sync accepted, awaiting the background worker.
processing — the worker is materialising tasks.

Terminal statuses:

complete — the sync finished. tasks_created, datapoints_processed, groups_created, and groups_expanded are populated.
failed — the sync failed. reason is populated.

Continue polling while the status is queued or processing.

Returns the current status of a batch sync job created by `POST /batches/{batch_id}/sync`. A sync job transitions through the following statuses: - `queued` — sync accepted, awaiting the background worker. - `processing` — the worker is materialising tasks. **Terminal statuses:** - `complete` — the sync finished. `tasks_created`, `datapoints_processed`, `groups_created`, and `groups_expanded` are populated. - `failed` — the sync failed. `reason` is populated. Continue polling while the status is `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

batch_idstringRequiredformat: "uuid"

The unique identifier of the batch

sync_idstringRequiredformat: "uuid"

The sync job ID returned by POST /batches/{batch_id}/sync

Response

Sync job status

batch_idstringformat: "uuid"

The batch this sync job belongs to.

dataset_idstringformat: "uuid"

The dataset whose appended datapoints are being synced.

sync_idstringformat: "uuid"

The unique identifier of the sync job.

created_atdatetime

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

updated_atdatetime

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

statusenum

Current status of the sync job.

tasks_createdinteger>=0

Number of tasks created this sync. Present when status is complete.

datapoints_processedinteger>=0

Number of datapoints processed this sync. Present when status is complete.

groups_createdinteger>=0

Number of new task groups created this sync. Present when status is complete.

groups_expandedinteger>=0

Number of existing task groups grown this sync. Non-zero only for predetermined-grouping batches; always 0 for tasks-per-group batches. Present when status is complete.

reasonstring

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

Errors

4XX

Client Request Error

404

Not Found Error

1	{
2	"batch_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3	"dataset_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
4	"sync_id": "1c6b147e-8f3a-4d2a-9f3b-2a1e4d5c6b7f",
5	"created_at": "2024-01-15T09:30:00Z",
6	"updated_at": "2024-01-15T09:45:00Z",
7	"status": "queued"
8	}