Skip to main content
GET
/
api
/
roleplay
/
session
/
{id}
Session - Get Results
curl --request GET \
  --url https://app.replay.sale/api/roleplay/session/{id} \
  --header 'x-api-key: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "activityType": "premade-roleplay",
  "activityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "didPass": true,
  "length": 1,
  "wpm": 1,
  "score": 1,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "user": {
    "learnerName": "<string>",
    "originDomain": "<string>",
    "uniqueIdentifier": "<string>"
  },
  "premadeRoleplay": {
    "title": "<string>",
    "passingScore": 1
  },
  "snippets": [
    {
      "isUser": true,
      "text": "<string>"
    }
  ],
  "nameCount": 1,
  "numQuestions": 1,
  "numFillerWords": 1,
  "scenario": {
    "title": "<string>"
  },
  "customerPersona": {
    "imageUrl": "<string>",
    "name": "<string>"
  },
  "customerSituation": {
    "title": "<string>"
  },
  "promptResponses": "(deprecated)",
  "criteriaResponses": [
    {
      "title": "<string>",
      "passed": true,
      "explanation": "<string>",
      "weight": 123,
      "sectionTitle": "<string>"
    }
  ],
  "metricResponses": [
    {
      "title": "<string>",
      "passed": true,
      "explanation": "<string>",
      "weight": 123,
      "sectionTitle": "<string>"
    }
  ],
  "audioUrl": "<string>",
  "videoUrl": "<string>"
}

Authorizations

x-api-key
string
header
required

API key for authentication. Get your API key from your company settings.

Path Parameters

id
string<uuid>
required

The UUID of the roleplay session to retrieve

Response

Successfully retrieved roleplay session

id
string<uuid>
required
activityType
enum<string>
required
Available options:
premade-roleplay
activityId
string<uuid>
required
didPass
boolean
required

Whether the roleplay met the passing score requirement

length
integer
required

Duration in milliseconds

Required range: x >= 0
wpm
number
required

Words per minute

Required range: x >= 0
score
number<float>
required
Required range: x >= 0
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
user
object
required
premadeRoleplay
object
required
snippets
object[]
required
nameCount
integer
Required range: x >= 0
numQuestions
integer
Required range: x >= 0
numFillerWords
integer
Required range: x >= 0
scenario
object
customerPersona
object
customerSituation
object
promptResponses
enum<string>

This field is deprecated. Use criteriaResponses and metricResponses instead.

Available options:
(deprecated)
criteriaResponses
object[]

Array of criterion responses from the SC scorecard system

metricResponses
object[]

Array of metric responses from the SC scorecard system

audioUrl
string<uri> | null

Pre-signed Google Cloud Storage URL to the audio recording (15 minute expiry). Only present if an audio recording exists.

videoUrl
string<uri> | null

Pre-signed Google Cloud Storage URL to the video recording (15 minute expiry). Only present if a video recording exists.