Sign in

v1

latestOpenAPI 3.0.02026-07-2493247.1 KB
Video Data

Obtain a highlight reel download link

Returns the details of a highlight reel and a link to download it.

If the highlight reel is still being prepared, the response returns a status of GENERATING and no link. Call this endpoint again every few seconds until the status becomes GENERATED, then use the reelUrl to download the highlight reel. The link is valid for 15 minutes; after it expires, call the endpoint again to get a new one.

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.
get/api/v2/testResults/{testId}/highlightreels/{reelId}

Path parameters

testIdstring uuid required

ID of the test the highlight reel belongs to.

reelIdstring uuid required

ID of the highlight reel you want to download.

Response

Highlight reel details successfully returned.

reelIdstring uuid required

ID of the highlight reel.

status'GENERATING' | 'GENERATED' | 'ERROR' required

Current state of the highlight reel.

  • GENERATING: the highlight reel is being prepared. Try again in a few seconds.
  • GENERATED: the highlight reel is ready and reelUrl contains the download link.
  • ERROR: something went wrong while preparing the highlight reel. Try the request again to start a new attempt.
reelUrlstring url nullable

Link to download the highlight reel file. Valid for 15 minutes. Returned only when the status is GENERATED; call this endpoint again to get a new link after it expires.

Example response

{
  "reelId": "8fdc898f-3b2b-4f45-91a2-2a6b618bc987",
  "status": "GENERATED",
  "reelUrl": "https://s3.amazonaws.com/usertesting-videosprod/reels/8fdc898f-3b2b-4f45-91a2-2a6b618bc987.mp4?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIOSFODNN7EXAMPLE%2F20260114%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20260114T120000Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=abcdef1234567890"
}