Sign in

v1

latestOpenAPI 3.0.02026-07-2493247.1 KB
Video Data

Obtain a clip download link

Returns the details of a clip and a link to download it.

If the clip 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 clipUrl to download the clip. The link is valid for 15 minutes; after it expires, call the endpoint again to get a new one.

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/{clipUuid}

Path parameters

sessionIdstring uuid required

ID of the session that contains the clip.

clipUuidstring uuid required

ID of the clip you want to download.

Response

Clip details successfully returned.

clipUuidstring uuid required

ID of the clip.

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

Current state of the clip.

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

Link to download the clip 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

{
  "clipUuid": "41f72104-5f84-44fa-a16a-03f575159611",
  "status": "GENERATED",
  "clipUrl": "https://s3.amazonaws.com/usertesting-videosprod/clips/41f72104-5f84-44fa-a16a-03f575159611.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"
}