List Batches

GET

https://api.prolific.com/api/v1/data-collection/batches

GET

/api/v1/data-collection/batches

1 import requests
2 
3 url = "https://api.prolific.com/api/v1/data-collection/batches"
4 
5 querystring = {"workspace_id":"workspace_id"}
6 
7 headers = {"Authorization": "Token <token>"}
8 
9 response = requests.get(url, headers=headers, params=querystring)
10 
11 print(response.json())

1 {
2   "results": [
3     {
4       "id": "a3f1c9d2-4b7e-4f8a-9c2d-1e5b7f3a9d8c",
5       "created_at": "2024-01-15T09:30:00Z",
6       "created_by": "6278cb09062dbb35bc4abebc",
7       "datasets": [
8         {
9           "id": "d4e5f6a7-b8c9-40d1-9e2f-3a4b5c6d7e8f",
10           "total_datapoint_count": 1500,
11           "filename": "customer_feedback_2024.csv"
12         }
13       ],
14       "name": "Customer Feedback Collection Q1 2024",
15       "status": "UNINITIALISED",
16       "total_task_count": 25,
17       "total_instruction_count": 5,
18       "workspace_id": "6278acb09062db3b35bcbeb0",
19       "schema_version": 1,
20       "task_details": {
21         "task_name": "Sentiment Analysis",
22         "task_introduction": "Analyze customer feedback to determine sentiment polarity.",
23         "task_steps": "1. Read each feedback entry. 2. Classify sentiment as positive, neutral, or negative. 3. Submit classification."
24       },
25       "total_task_groups": 3
26     }
27   ],
28   "meta": {
29     "count": 1
30   }
31 }

Get all AI Task Builder batches by workspace id

Authentication

AuthorizationToken

Header authentication of the form Token <token>

Query parameters

workspace_idstringRequired

The unique identifier of the workspace

Response

resultslist of objects or null

metaobject or null

Authentication

Query parameters

Response

Errors