HomeDocumentationAPI Reference
Documentation

How to Obtain UUIDs

Indications on where to find required UUIDs for v1 endpoints.

Finding the required Universally Unique Identifier (UUID) for a v1 endpoint isn't always intuitive. This guide indicates how to manually obtain the required UUIDs on the UserTesting web page.

Clip UUIDs

The v1/clip/CLIP_UUID endpoint allows you to get clips. Clips are segments of sessions videos that can be shared with stakeholders for analysis. They can be shared individually or as part of a highlight reel.

📘

Note: Only video clips from the following test (study) types can be requested through the v1/clip/CLIP_UUID endpoint:

Test type (UI name)type (API)
Live Conversation (Classic experience)LIVE
Video UploadEXTERNAL_UPLOAD
Prototype test (Unmoderated tests - Classic test types)PROTOTYPE
App test (Unmoderated tests - Classic test types)APP
Web test (Unmoderated tests - Classic test types)WEB

To use the endpoint, you'll need to provide the clip's UUID as a path parameter in the request. The clip's UUID can only be manually obtained through the URL address bar of your browser when you open the clip.

👍

Tip: If need to access a clip that is found within a highlight reel, you can use the /v1/ highlightreel/HIGHLIGHT_ID endpoint to get the URL that contains the UUID. See the Highlight reel UUIDs section for details.

How to manually obtain a clip UUID

Follow these steps to open a clip and obtain its UUID on the UserTesting web page:

  1. Open the UserTesting homepage and navigate to the Tests section.

  2. Select a test type with video clips supported by the clips endpoint, e.g., Live Conversation.

    Tests section in UserTesting UI


  3. Select a test with completed sessions.

  4. Play a session with clips. (Or create your own clips within the session video).

    List of sessions within a test or study


  5. Click a clip's options menu and select Share.

    Session video with clip management


  6. Click Copy link and then Done.

    Share clip dialog box

  7. Paste the link in a new browser tab (or any text field).

  8. From the URL you just pasted, copy the UUID.

    UUID selected within URL on address bar


  9. Store the UUID for use on your v1/clip/CLIP_UUID endpoint request.


Highlight reel UUIDs

A highlight reel is a collection of clips that can be shared with external users to showcase significant moments within a session.

Use the /v1/ highlightreel/HIGHLIGHT_TOKEN endpoint to obtain highlight reel data. To use the highlight reel endpoint you must provide the highlight reel TOKEN as a path parameter in the request.

The highlight reel token can only be obtained manually.

📘

The v1 highlight reel endpoint is only compatible with the following test (study) types:

Test type (UI name)type (API)
Live Conversation (Classic experience)LIVE
Video UploadEXTERNAL_UPLOAD
Prototype test (Unmoderated tests - Classic test types)PROTOTYPE
App test (Unmoderated tests - Classic test types)APP
Web test (Unmoderated tests - Classic test types)WEB

How to manually obtain the highlight reel token

  1. From the UserTesting homepage, select Highlight reel on the navigation panel.

  2. Select a highlight reel from the list.

    Highlight reels section


  3. After the highlight reel opens on the web browser, copy the token from the URL in the address bar.

    Highlight reel player


  4. Store the token for use on your /v1/ highlightreel/HIGHLIGHT_TOKEN request.


 Study UUIDs

Obtain a study (test) UUID to use on the /v1/studies/STUDIES_UUID and /v1/studies/STUDIES_UUID/completed-sessions endpoints to obtain test configuration information or details about each session within the study (test) respectively.

📘

Only the following test (study) types are compatible with v1 endpoints:

Test type (UI name)type (API)
Live Conversation (Classic experience)LIVE
Video UploadEXTERNAL_UPLOAD
Prototype test (Unmoderated tests - Classic test types)PROTOTYPE
App test (Unmoderated tests - Classic test types)APP
Web test (Unmoderated tests - Classic test types)WEB

To obtain a study (test) UUID, you can either:

  • use the the v1/workspaces/WORKSPACE_ID API endpoint
  • or do it manually through the UserTesting web page as indicated in the next section

Manually obtaining a study UUID:

  1. From the UserTesting home page, go to the Tests section.

  2. Select a test.

    Test section


  3. Click the Actions dropdown menu.

  4. From the dropdown menu, select Edit test details.

    Test sessions page


  5. Copy the UUID found within the URL that is in the address bar.

    Edit Test Details page

  6. Store the UUID for use on the corresponding endpoints.


Session UUIDs

A session is a record of a participant's interaction with a test.

Use the /v1/session/SESSION_UUID endpoint to get session metadata.

To obtain a session UUID, you can use either of the following methods:


Manually obtaining a session UUID:

  1. From the UserTesting home page, go to the Tests section.

  2. Select a test.

    Test section

  3. From Sessions list, select a session.

    Sessions page

  4. Copy the UUID found within the URL that is in the address bar.

    Session video player

  5. Store the UUID for use with the /v1/workspaces/SESSION_UUID endpoint.


Workspace UUIDs

To obtain workspace UUIDs, it's preferable to use the /v1/workspaces endpoint.