| Learn the frequently asked questions about UserTesting's Results API, including supported test types, limitations, and best practices for working with the API. |
On this page:
Overview
The Results API allows you to programmatically retrieve session data from supported UserTesting tests. Using this API, teams can integrate research insights into analytics pipelines, dashboards, or internal tools.
Through the Results API, you can retrieve:
- Lists of completed sessions for a test
- Session-level details such as participant demographics and responses
- Links to session videos
- QXscore metrics for interaction tests
- Transcripts for think-out-loud tests (TOL is currently in Beta)
Access to data depends on the workspaces associated with the user whose credentials are used for authentication.
Is the Results API bi-directional?
No.
The Results API supports GET requests only, meaning it can retrieve data but cannot send or modify data in the UserTesting platform.
What is the API rate limit?
- The Results API is rate-limited to 10 requests per 60 seconds.
- If this limit is exceeded, the API returns:
HTTP 429 – Too Many Requests - Your integration should include retry logic or request throttling to avoid hitting this limit.
Which sessions are returned by the API?
- The Results API returns only completed sessions.
- Incomplete or abandoned sessions are not included in the response results.
Which test types are supported by the Results API?
The Results API works only with the latest UserTesting test types, including:
- Surveys
- Interaction tests
- Think-out-loud tests (Beta)
For these tests, the API can return:
- Session summaries
- Participant demographics
- Task responses
- QXscore metrics (interaction tests)
- Session video links
- Video transcripts (think-out-loud tests - TOL is currently in Beta)
Are classic UserTesting tests supported?
No.
The Results API does not support classic UserTesting test types, including:
- Live Conversation
- Video Upload
- Prototype Test
- App Test
- Web Test
To retrieve data from these tests, you must use the legacy Results API.
Why don't I see results for a specific test?
There are several possible reasons:
- The test is a classic UserTesting test type (legacy API required)
- The session has not been completed
- The workspace associated with your API credentials does not have access to the test
- The test ID is incorrect
How do I find a test ID (UUID)?
- Currently, test IDs must be manually extracted from the test URL in the UserTesting platform.
- Example: https://app.usertesting.com/tests/{TEST_ID}/results
- The TEST_ID (UUID) from the URL is used in API requests.
Can I programmatically retrieve all test IDs?
- Some customers use the workspace studies endpoint to retrieve study IDs and then query the Results API endpoints.
- However, there is a known limitation:
- The workspace studies endpoint does not currently indicate whether a study is UTC (Classic) or the new experience, UTZ (Next-Gen).
- As a result, you may retrieve IDs that cannot be used with the Results API.
- A platform update is planned to include product type metadata in this endpoint.
How do I retrieve sessions for a test?
- You can use the endpoint:
GET /api/v2/sessionResults - This endpoint returns a paginated list of session summaries for completed sessions in a test.
- Sessions are returned in descending order (newest first).
Pagination parameters include:
- limit
- offset
Best practices
To ensure reliable API usage:
- Implement pagination logic when retrieving sessions
- Use rate limiting or backoff strategies
- Validate that tests are supported test types
- Store test IDs securely when integrating automated pipelines
Related Content
|
Want to learn more? Check out these Knowledge Base articles... |
Interested in growing your skills? Check out our University courses... |
|
Need hands-on training?
|
Can't find your answer?
|