v1
latestOpenAPI 3.0.02026-07-2493247.1 KBGeneral Session Data
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.
Compatibility:
- All tests with the "STUDYV2" type are compatible. These include tests with the following product types:
- "SURVEY" (survey)
- "LIVE_CONVERSATION" (non-classic live conversation)
- "NON_THINK_OUT_LOUD" (interaction test)
- "THINK_OUT_LOUD" (think-out-loud test)
- Go to How to Obtain a Test ID (UUID) for details.
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:
- For an example on near real-time polling, go to Stream Insights into Slack or Jira.
- For an example on how to add session summaries into an automated research data pipeline, go to Create an Automated Pipeline.
get/api/v2/sessionResults
Query parameters
testIdstring uuid required
ID of the test containing the sessions.
limitnumber
Example:25
Maximum number of sessions to return in the result set.
offsetnumber
Number of sessions to skip before starting to collect the result set.
Response
Session summaries successfully retrieved.
Example response
{
"testId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"sessions": [
{
"sessionId": "41f72104-5f84-44fa-a16a-03f5751596ec",
"audienceId": "41f72104-5f84-44fa-a16a-03f575159611",
"status": "COMPLETE",
"startTime": "2024-11-21T12:23:52.614Z",
"finishTime": "2024-11-21T12:25:03.347Z"
}
],
"meta": {
"pagination": {
"limit": 25,
"totalCount": 1
}
}
}