v4
OpenAPI 3.1.02026-07-31121440441.0 KBaiTaskBuilder
Get Schema Migration Status
Returns the current status of a schema migration job, which reprocesses a V4 dataset's datapoints against a newer schema version.
A migration job has these statuses:
- processing — the migration is underway.
Terminal statuses:
- complete — all datapoints were reprocessed. reprocessed_count is populated.
- partial — some datapoints were reprocessed and some fields could not be re-normalised (and were nulled). reprocessed_count, failed_count, and errors are populated.
- failed — the migration failed entirely. reason is populated.
Continue polling while the status is processing.
get/api/v1/data-collection/datasets/{dataset_id}/schema-migrations/{job_id}
Path parameters
dataset_idstring uuid required
The unique identifier of the dataset
job_idstring uuid required
The schema migration job ID
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
Schema migration job status