v1

latestOpenAPI 3.0.02026-07-2493247.1 KB

Video Data

Find all clips for a session video

Returns the clips created from a session video, including clip timing, media flags, layout, and video region metadata.

Compatibility:

Sessions must be found within tests with the "STUDYV2" type and belong to one of the following product types that support session video clips:
- "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.

get/api/v2/sessionResults/{sessionId}/clips

Path parameters

sessionIdstring uuid required

ID of the session whose video clips you want to retrieve.

Response

Clips successfully retrieved.

studyUuidstring uuid required

ID of the test associated with the clip list.

Example response

{
  "studyUuid": "e320c95c-2741-49bc-9e04-37b77d6fece3",
  "clips": [
    {
      "uuid": "a0ff28a2-020b-4944-ab5a-ba035269641e",
      "name": "Clip #1",
      "description": "Maurice's awesome review",
      "timeStartMs": 3708,
      "timeEndMs": 33708,
      "videoUuid": "5a1d8707-0cf1-47d4-86f3-7c7b8722921d",
      "hasAudio": true
    }
  ],
  "videoRegions": {
    "screen": {
      "widthPx": 1920,
      "heightPx": 1080
    },
    "camera": {
      "widthPx": 1920,
      "heightPx": 1080
    }
  }
}