Skip to main content
GET
/
api
/
memorization
/
session
Session - Get For User
curl --request GET \
  --url https://app.replay.sale/api/memorization/session \
  --header 'x-api-key: <api-key>'
{
  "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "scriptId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "numTotalAttempts": 1,
  "numPassedLevels": 1,
  "numTotalLevels": 2,
  "currentLevel": 2,
  "didPassAllLevels": true,
  "attempts": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "score": 50,
      "createdAt": "2023-11-07T05:31:56Z",
      "attemptedLevel": 2,
      "didPass": true
    }
  ]
}

Authorizations

x-api-key
string
header
required

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

Query Parameters

userId
string<uuid>
required

The user ID (required)

scriptId
string<uuid>
required

The script ID (required)

Response

Successfully retrieved session

userId
string<uuid>
required
scriptId
string<uuid>
required
numTotalAttempts
integer
required

Total number of attempts

Required range: x >= 0
numPassedLevels
integer
required

Number of levels passed

Required range: x >= 0
numTotalLevels
integer
required

Total number of levels

Required range: x >= 1
currentLevel
integer
required

Current level the user is on

Required range: x >= 1
didPassAllLevels
boolean
required

Whether all levels have been passed

attempts
object[]
required