Fetching responses
Accessing Participant Responses via the API
The responses endpoint provides access to complete participant response objects from a study. Each response includes identifiers, timestamps, status fields, and links to associated data such as transcripts, recordings, and metadata. This makes it possible to query, display, and analyze participant sessions programmatically.
Response data is most easily accessed by selecting the resultsSortFilter
field from the UserTestNode
. This field returns a JSON-encoded string containing response objects, which must be decoded on the client side after retrieval. It is returned in this fashion due to a specific serialisation layer that allows you to access all the response data in one fast call.
Developers can:
Fetch all responses for a given
testId
or retrieve an individualresponseId
.Access response metadata such as completion status, rejection flags, and submission times.
Follow links to transcripts, media, and feeds for deeper analysis.
Use filtering or pagination to handle large datasets efficiently.
Note: Responses act as the entry point to most session data. They provide references to related resources but do not inline heavy assets like transcripts or media files, which must be fetched separately.
Example query
Here we're going to select a UserTestNode
using its UUID. For an explanation of how to find a test's UUID, see Projects.
Example response
The resultsSortFilter
field will return a JSON-encoded string, which will need to be decoded on your side once the response comes back.
Within the JSON will be each response, and within each response is each step response, which contains the step type, step UUID & the respondent's answer for each step. The exact data format changes depending on the step type.
Once decoded, the data will be structured something like this:
Tying a response to a question
In our query above we also asked the server to return the text and UUID for each step in the test. You can use the step UUID to tie the answer to the original question text.