Create response | Prolific API

1 import requests 2 3 url = "https://api.prolific.com/api/v1/surveys/survey_id/responses/" 4 5 payload = { 6 "participant_id": "62908f0b98a55b36ac68b992", 7 "submission_id": "62908f0b98a55b36ac68b992", 8 "sections": [ 9 { 10 "questions": [ 11 { 12 "answers": [ 13 { 14 "answer_id": "8bde0c5f-235e-41e6-bf82-b73e92852ac8", 15 "value": "Potato" 16 } 17 ], 18 "question_id": "827e810a-4b1a-40f6-8bc2-c3dd6fcedc25", 19 "question_title": "What is your favourite root vegetable?" 20 } 21 ], 22 "section_id": "f5e5c4dc-7d2e-40f1-a895-9bb2f8703fd8" 23 } 24 ] 25 } 26 headers = { 27 "Authorization": "<apiKey>", 28 "Content-Type": "application/json" 29 } 30 31 response = requests.post(url, json=payload, headers=headers) 32 33 print(response.json())

1 { 2 "participant_id": "62908f0b98a55b36ac68b992", 3 "submission_id": "62908f0b98a55b36ac68b992", 4 "_id": "62fccc6ea792097ae2145ca4", 5 "sections": [ 6 { 7 "questions": [ 8 { 9 "answers": [ 10 { 11 "answer_id": "8bde0c5f-235e-41e6-bf82-b73e92852ac8", 12 "value": "Potato" 13 } 14 ], 15 "question_id": "827e810a-4b1a-40f6-8bc2-c3dd6fcedc25", 16 "question_title": "What is your favourite root vegetable?" 17 } 18 ], 19 "section_id": "f5e5c4dc-7d2e-40f1-a895-9bb2f8703fd8" 20 } 21 ] 22 }

Create a Response for a survey.

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

survey_idstringRequired

Request

This endpoint expects an object.

participant_idstringRequired

The Prolific participant ID.

submission_idstringRequired

The Prolific submission ID.

sectionslist of objectsOptional

An array of sections from the survey, otherwise use questions.

questionslist of objectsOptional

An array of questions from the survey, otherwise use sections.

Response

Successful Response

participant_idstring

The Prolific participant ID.

submission_idstring

The Prolific submission ID.

_idstring or null

date_createddatetime or null

The date/time the response was created (UTC).

date_modifieddatetime or null

The date/time the response was modified (UTC).

sectionslist of objects or null

An array of sections from the survey, otherwise questions.

questionslist of objects or null

An array of questions from the survey, otherwise sections.

Authentication

Path Parameters

Request

Response

Errors