List study feedback

GET

https://api.prolific.com/api/v1/studies/:id/feedback/responses/

GET

/api/v1/studies/:id/feedback/responses/

curl https://api.prolific.com/api/v1/studies/id/feedback/responses/ \
     -H "Authorization: Token <token>"

{
  "results": [
    {
      "participant_id": "60a1b2c3d4e5f60718293a4b",
      "source": "completed",
      "category": [
        "technical-issue"
      ],
      "text": "The page froze when I tried to submit.",
      "ratings": {
        "clarity_rating": 4,
        "difficulty_rating": 2,
        "fairness_rating": 5
      }
    },
    {
      "participant_id": null,
      "source": "dismissed",
      "category": [
        "low-reward"
      ]
    }
  ],
  "meta": {
    "count": 2,
    "facets": {
      "source": [
        {
          "value": "completed",
          "count": 1
        },
        {
          "value": "dismissed",
          "count": 1
        }
      ],
      "category": [
        {
          "value": "technical-issue",
          "count": 1
        },
        {
          "value": "low-reward",
          "count": 1
        }
      ]
    }
  },
  "_links": {
    "self": {
      "href": "https://api.prolific.com/api/v1/studies/60aca280709ee40ec37d4885/feedback/responses/",
      "title": "Current"
    },
    "related": [
      {
        "href": "https://api.prolific.com/api/v1/studies/60aca280709ee40ec37d4885/",
        "title": "Study"
      }
    ]
  }
}

Returns the feedback participants have left about a study, including their reasons, written comments and ratings.

Limited availability. This endpoint is not yet available to all accounts. If you need access, please contact Prolific support.

A participant’s ID is only included when they have agreed to share it; otherwise participant_id is null.

Authentication

AuthorizationToken

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

idstringRequired

Study id

Query parameters

has_written_feedbackbooleanOptionalDefaults to false

Only return feedback that includes a written comment.

sourcestringOptional

Comma-separated list of feedback sources to include, for example completed,returned.

categorystringOptional

Comma-separated list of feedback categories to include, for example technical-issue,screened-out.

limitintegerOptional>=0

Number of results to return per page. Defaults to 25.

offsetintegerOptional>=0

Number of results to skip.

Response

A page of feedback for the study

resultslist of objects

metaobject

_linksmap from strings to anyOptional

HAL-style links; typically includes self and related.

Errors

4XX

Client Request Error