v4

latestOpenAPI 3.1.02026-07-31121440441.0 KB
aiTaskBuilder

Get Batch Report

Get a presigned URL to download the batch responses as a CSV report. The CSV contains your original dataset with additional columns for participant responses.

get/api/v1/data-collection/batches/{batch_id}/report/

Path parameters

batch_idstring required

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

OK

urlstring

Presigned URL to download the CSV report

expires_atstring date-time

When the presigned URL expires

http_method'GET'

HTTP method to use with the presigned URL