> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.prolific.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.prolific.com/_mcp/server.

# Get Schema Migration Status

GET https://api.prolific.com/api/v1/data-collection/datasets/{dataset_id}/schema-migrations/{job_id}

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

Reference: https://docs.prolific.com/api-reference/ai-task-builder/get-schema-migration-status

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: Prolific API for Data Collectors
  version: 1.0.0
paths:
  /api/v1/data-collection/datasets/{dataset_id}/schema-migrations/{job_id}:
    get:
      operationId: get-schema-migration-status
      summary: Get Schema Migration Status
      description: >-
        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`.
      tags:
        - aiTaskBuilder
      parameters:
        - name: dataset_id
          in: path
          description: The unique identifier of the dataset
          required: true
          schema:
            type: string
            format: uuid
        - name: job_id
          in: path
          description: The schema migration job ID
          required: true
          schema:
            type: string
            format: uuid
        - name: Authorization
          in: header
          description: >-
            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>`.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Schema migration job status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SchemaMigrationJob'
        '400':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Schema migration job not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
servers:
  - url: https://api.prolific.com
    description: Production
components:
  schemas:
    SchemaMigrationJobStatus:
      type: string
      enum:
        - processing
        - complete
        - partial
        - failed
      description: Current status of the migration job.
      title: SchemaMigrationJobStatus
    SchemaMigrationError:
      type: object
      properties:
        datapoint_id:
          type: string
          format: uuid
          description: The datapoint whose field could not be re-normalised.
        field:
          type: string
          description: The schema field key that was nulled.
        reason:
          type: string
          description: Human-readable description of why the field was nulled.
      required:
        - datapoint_id
        - field
        - reason
      description: >-
        A single record-level failure — a field that was invalid under the new
        schema and so was nulled.
      title: SchemaMigrationError
    SchemaMigrationJob:
      type: object
      properties:
        dataset_id:
          type: string
          format: uuid
          description: The dataset being migrated.
        job_id:
          type: string
          format: uuid
          description: The unique identifier of the schema migration job.
        schema_version:
          type: integer
          description: The schema version this job reprocesses datapoints up to.
        created_at:
          type: string
          format: date-time
          description: When the migration job was created (ISO 8601, UTC).
        updated_at:
          type: string
          format: date-time
          description: When the migration job was last updated (ISO 8601, UTC).
        status:
          $ref: '#/components/schemas/SchemaMigrationJobStatus'
          description: Current status of the migration job.
        reprocessed_count:
          type: integer
          description: >-
            Number of datapoints reprocessed. Present when status is `complete`
            or `partial`.
        failed_count:
          type: integer
          description: >-
            Number of datapoints with at least one field that could not be
            re-normalised. Present when status is `partial`.
        errors:
          type: array
          items:
            $ref: '#/components/schemas/SchemaMigrationError'
          description: >-
            Record-level failures — fields nulled because they were invalid
            under the new schema. Present when status is `partial`.
        reason:
          type: string
          description: Human-readable reason for failure. Present when status is `failed`.
      required:
        - dataset_id
        - job_id
        - schema_version
        - created_at
        - updated_at
        - status
      description: >-
        Tracks the asynchronous re-normalisation of a V4 dataset's datapoints
        against a newer schema

        version. Poll `GET /datasets/{dataset_id}/schema-migrations/{job_id}`
        until a terminal

        status (`complete`, `partial`, or `failed`).


        The shape depends on `status`: the fields below marked as terminal-only
        are present only for

        the corresponding status.
      title: SchemaMigrationJob
    ErrorDetailDetail2:
      type: object
      properties:
        any_field:
          type: array
          items:
            type: string
          description: >-
            Name of the field with a validation error and as a value an array
            with the error descriptions
      description: All fields with validation errors
      title: ErrorDetailDetail2
    ErrorDetailDetail:
      oneOf:
        - type: string
        - type: array
          items:
            type: string
        - $ref: '#/components/schemas/ErrorDetailDetail2'
      description: Error detail
      title: ErrorDetailDetail
    ErrorDetail:
      type: object
      properties:
        status:
          type: integer
          description: Status code as in the http standards
        error_code:
          type: integer
          description: Internal error code
        title:
          type: string
          description: Error title
        detail:
          $ref: '#/components/schemas/ErrorDetailDetail'
          description: Error detail
        additional_information:
          type: string
          description: Optional extra information
        traceback:
          type: string
          description: Optional debug information
        interactive:
          type: boolean
      required:
        - status
        - error_code
        - title
        - detail
      title: ErrorDetail
    Error:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/ErrorDetail'
      required:
        - error
      title: Error
  securitySchemes:
    token:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        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>`.

```

## Examples



**Request**

```json
{}
```

**Response**

```json
{
  "dataset_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "job_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "schema_version": 3,
  "created_at": "2024-01-15T09:30:00Z",
  "updated_at": "2024-01-15T10:00:00Z",
  "status": "processing"
}
```

**SDK Code**

```python
import requests

url = "https://api.prolific.com/api/v1/data-collection/datasets/dataset_id/schema-migrations/job_id"

payload = {}
headers = {
    "Authorization": "Token <token>",
    "Content-Type": "application/json"
}

response = requests.get(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.prolific.com/api/v1/data-collection/datasets/dataset_id/schema-migrations/job_id';
const options = {
  method: 'GET',
  headers: {Authorization: 'Token <token>', 'Content-Type': 'application/json'},
  body: '{}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.prolific.com/api/v1/data-collection/datasets/dataset_id/schema-migrations/job_id"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("GET", url, payload)

	req.Header.Add("Authorization", "Token <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.prolific.com/api/v1/data-collection/datasets/dataset_id/schema-migrations/job_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Token <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.prolific.com/api/v1/data-collection/datasets/dataset_id/schema-migrations/job_id")
  .header("Authorization", "Token <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.prolific.com/api/v1/data-collection/datasets/dataset_id/schema-migrations/job_id', [
  'body' => '{}',
  'headers' => [
    'Authorization' => 'Token <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.prolific.com/api/v1/data-collection/datasets/dataset_id/schema-migrations/job_id");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Token <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Token <token>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.prolific.com/api/v1/data-collection/datasets/dataset_id/schema-migrations/job_id")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```