Accessing a List of All Sessions within a Test via the Results API

Learn how to use the Public Results API v2 to retrieve a list of completed session results for a specific test. This endpoint provides high-level session metadata and supports pagination for large-scale studies.

 

On this page:


 

Overview

This endpoint allows you to programmatically access all completed session summaries for a given test. This is useful for:

  • Exporting data to analytics or BI tools
  • Displaying participant summaries in dashboards
  • Running automated analysis across tests

For task-level response data, use the Detailed Session Results Endpoint.

 

 

Endpoint

 



 

Parameters
 

Parameter Type Required Description
testId UUID ✅ Yes The ID of the test to retrieve session results from
limit Integer ❌ No Max sessions to return (1–500). Default: 100
offset Integer ❌ No Number of sessions to skip. Default: 0

Only sessions with a COMPLETE status are returned in this version. No other filters are currently supported.






 

Headers
 

Header Description Required Values
Authorization Bearer access token Yes

Bearer <ACCESS_TOKEN>


 

 

 

Response Structure



 

Error Handling
 

Error code Description Notes
400 Bad request. The offset must be between 0-10000 and the limit must be between 1-500.
401 Missing or invalid access token. Generate a new token, it may be expired.
404 Test not found. It either doesn’t exist or you don’t have permission.
429 Too many requests. Maximum of 10 requests per minute.

 

 

 

Performance and Pagination

  •  Offset pagination, using limit and offset
  • Optimized to support ten thousand sessions
  • Maximum return size: 500 per request


 

 

 

Related content

information icon.png

knowledge icon.png

Want to learn more? Check out these Knowledge Base articles... 

Interested in growing your skills? Check out our University courses...

video icon 2.png

team icon.png

Need hands-on training?

Can't find your answer?

Was this article helpful?