Get Batch Report

GET

https://api.prolific.com/api/v1/data-collection/batches/:batch_id/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.

Authentication

AuthorizationToken

Header authentication of the form Token <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	import requests
2
3	url = "https://api.prolific.com/api/v1/data-collection/batches/batch_id/report/"
4
5	headers = {"Authorization": "Token <token>"}
6
7	response = requests.get(url, headers=headers)
8
9	print(response.json())

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