PRprolific
aiTaskBuilder

Get Batch Sync Status

Changed on

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.

get/api/v1/data-collection/batches/{batch_id}/syncs/{sync_id}

Request

  • Base URL
    https://api.prolific.com
  • URL
    https://api.prolific.com/api/v1/data-collection/batches/{batch_id}/syncs/{sync_id}
  • Auth
    API key in header Authorization

Path parameters

batch_idstring uuid required

The unique identifier of the batch

sync_idstring uuid required

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

Response

Sync job status

batch_idstring uuid required

The batch this sync job belongs to.

dataset_idstring uuid required

The dataset whose appended datapoints are being synced.

sync_idstring uuid required

The unique identifier of the sync job.

created_atstring date-time required

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

updated_atstring date-time required

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

status'queued' | 'processing' | 'complete' | 'failed' required

Current status of the sync job.

tasks_createdinteger

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

datapoints_processedinteger

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

groups_createdinteger

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

groups_expandedinteger

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.

Changes

  • 6c9aa73fa51fRevision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security token was added to the API

  • e9e1e322aacbRevision changes
    • info

      api operation id get-batch-sync-status removed and replaced with aiTaskBuilder_GetBatchSyncStatus