Sign in

v1

latestOpenAPI 3.0.02026-07-2493247.1 KB
Video Data

Find all highlight reels for a test

Returns all highlight reels for the test. Each highlight reel includes its ID, name, duration, last updated timestamp, clip count, and whether all test clips are included in the reel.

Compatibility:

  • Tests must be of the "STUDYV2" type and belong to one of the following product types:
    • "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.

Notes:

  • Use the returned highlight reel ID to request highlight reel download link from the "GET /api/v2/testResults/{testId}/highlightreels/{reelId}" endpoint.
get/api/v2/testResults/{testId}/highlightreels

Path parameters

testIdstring uuid required

ID of the test whose highlight reels you want to retrieve.

Response

Highlight reels successfully retrieved.

studyWithClipsboolean required

Indicates whether the study has clips available.

Example response

{
  "reels": [
    {
      "uuid": "8fdc898f-3b2b-4f45-91a2-2a6b618bc987",
      "name": "Checkout highlights",
      "durationMs": 120000,
      "lastUpdatedAtMs": 1766051123000,
      "numClips": 4,
      "areAllClipsInReel": true
    }
  ],
  "studyWithClips": true
}