Get Batch Report | Prolific API

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.

Authentication

Authorizationstring

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_idstringRequired

Response

urlstring or null

Presigned URL to download the CSV report

expires_atdatetime or null

When the presigned URL expires

http_methodenum or null

HTTP method to use with the presigned URL

Allowed values:

1	curl https://api.prolific.com/api/v1/data-collection/batches/batch_id/report/ \
2	-H "Authorization: <apiKey>"

1	{
2	"url": "https://storage.example.com/reports/batch_12345_responses.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIOSFODNN7EXAMPLE%2F20240615%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240615T093000Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890",
3	"expires_at": "2024-06-15T10:30:00Z",
4	"http_method": "GET"
5	}

Authentication

Path parameters

Response

Errors