v1

latestOpenAPI 3.0.02026-07-2493247.1 KB

General Session Data

Retrieve session details (v3)

Returns detailed information about a session, including participant demographics, task-group metadata, and individual task responses.

Compatibility:

All sessions found within tests with the "STUDYV2" type are compatible. These include tests from 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.

Use case examples:

For an example on how to understand and model session-level details and participant demographics, go to Model Session Details & Demographics.
For an example on how to add session details into an automated research data pipeline, go to Create an Automated Pipeline.
For an example on near real-time polling, go to Stream Insights into Slack or Jira.

get/api/v3/sessionResults/{sessionId}

Path parameters

sessionIdstring uuid required

ID of the session.

Response

Session details successfully retrieved.

sessionIdstring uuid nullable required

ID of the session.

audienceIdstring uuid nullable required

ID of the audience.

testPlanIdstring uuid nullable required

ID of the test plan.

Example response

{
  "sessionId": "f3c00502-256d-4693-b1b3-7dbd7eb64ca9",
  "audienceId": "550e8400-e29b-41d4-a716-446655440000",
  "testPlanId": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
  "sessionParticipant": {
    "participantId": "41f72104-5f84-44fa-a16a-03f575159611",
    "demographicsInfo": [
      {
        "id": "3f1b8c2e-9a44-4c3d-b8b7-1a7f4c0a9d21",
        "code": "GENDER",
        "label": "What is your gender?",
        "value": "Male",
        "type": "DEMOGRAPHIC_QUESTION_TYPE_SINGLE"
      }
    ]
  },
  "taskGroups": [
    {
      "uuid": "550e8400-e29b-41d4-a716-446655440000",
      "type": "QX_SCORE",
      "response": {
        "score": 85
      }
    }
  ],
  "tasks": [
    {
      "uuid": "12debc51-0948-4d2e-9abe-9844ddd5c5ff",
      "text": "Rate Website A",
      "type": "RATING_SCALE",
      "response": {
        "startTimeMs": 15000,
        "endTimeMs": 20000
      }
    }
  ]
}