HomeDocumentationAPI Reference
API Reference

Find all sessions in a test

Returns a paginated list of summaries for each completed session in a test. Each summary includes the session ID, status, and timestamps.

In the response, sessions are sorted in descending order, i.e., from newest to oldest.

Notes:

  • Works only on the latest test types, for example: Surveys, Interaction tests, and Think-out-loud tests.
  • The Think-out-loud test type is still in beta and not available to all customers.

Best practices:

  • Always use pagination query parameters (limit and offset) along with the appropriate logic to ensure all sessions are retrieved.
  • Use the response data from limit, offset, and totalCount in the meta.pagination property to calculate the number of pagination iterations (API requests) needed to collect all sessions in the test.

Use case examples:

Query Params
uuid
required

ID of the test containing the sessions.

number
1 to 500
Defaults to 25

Maximum number of sessions to return in the result set.

number
0 to 10000
Defaults to 0

Number of sessions to skip before starting to collect the result set.

Responses

400

Bad request. The offset must be between 0-10000 and limit must be between 1-500.

401

Missing or invalid access token.

404

Test not found.

429

Too many requests. Maximum of 10 requests per minute.

Language
Credentials
Bearer
JWT
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json