Skip to main content
POST
/
studies
/
{studyId}
/
responses
/
search
Search screener/survey responses for a study
curl --request POST \
  --url https://api.rallyuxr.com/api/public/v1/studies/{studyId}/responses/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "includeQuestions": false,
  "pageInfo": {
    "size": 10
  }
}
'
{
  "results": [
    {
      "submissionId": "<string>",
      "personId": "<string>",
      "participantId": "<string>",
      "state": "NONE",
      "submittedAt": "2023-11-07T05:31:56Z",
      "responses": [
        {
          "screenerQuestionId": "<string>",
          "values": [
            "<string>"
          ],
          "selectedOptionIds": [
            "<string>"
          ]
        }
      ]
    }
  ],
  "total": 123,
  "pageInfo": {
    "hasNextPage": true,
    "hasPreviousPage": true,
    "startCursor": "<string>",
    "endCursor": "<string>"
  },
  "questions": [
    {
      "screenerQuestionId": "<string>",
      "name": "<string>",
      "order": 123
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
studyId
string
required

Body

application/json
​
includeQuestions
boolean
default:false

When true, the response includes a questions array (id, name, order) for the study screener

​
pageInfo
object

Pagination: size and optional startCursor (submission id)

Example:
{ "size": 10 }

Response

The study responses

​
results
object[]
required
​
total
number
required

The total number of items in your workspaces based on your search parameters

​
pageInfo
object
required

Information about the current page

​
questions
object[]

Present when includeQuestions was true on the request; maps screenerQuestionId in responses to question text