Sessions API

Retrieve Session Information

GET /sessions/{sessionID}

Retrieve detailed information about a specific session. Keep in mind only sessions from your associated groups and participants are available for viewing, and certain information may not be viewable depending on privacy settings.

Headers

{ "x-api-key": "YOUR_API_KEY" }

URL Parameters

• sessionID (required): The identifier for the session.

Example Call

JavaScript

await fetch(
  "https://api.okaya.me/sessions/session1",
  {
    method: "GET",
    headers: {
      "x-api-key": "YOUR_API_KEY",
    },
  }
).then((response) => response.json());

Python

import requests

requests.get("https://api.okaya.me/sessions/session1",
    headers={
        "x-api-key": "YOUR_API_KEY"
    },
).json()

cURL

curl --location "https://api.okaya.me/sessions/session1" \
--header "x-api-key: YOUR_API_KEY"

Example Response

200

privacyLevel 0

{
  "externalID": "ok_participant1",
  "sessionID": "abcd1234",
  "timestamp": "2024-01-01T00:00:00Z",
  "groupID": 123456,
  "version": "v1.1.8",
}

privacyLevel 1

{
  "externalID": "ok_participant1",
  "sessionID": "abcd1234",
  "timestamp": "2024-01-01T00:00:00Z",
  "groupID": 123456,
  "version": "v1.1.8",
  "mhci": 70.0,
  "subscores": {
    "vision": 65.0,
    "audio": 70.0,
    "transcript": 75.0,
    "assessment": 70.0
  }
}

privacyLevel 2

{
  "externalID": "ok_participant1",
  "sessionID": "abcd1234",
  "timestamp": "2024-01-01T00:00:00Z",
  "groupID": 123456,
  "version": "v1.1.8",
  "mhci": 70.0,
  "subscores": {
    "vision": 65.0,
    "audio": 70.0,
    "transcript": 75.0,
    "assessment": 70.0
  },
  "groupPercentiles": {
    "feature1": 0.5,
    "feature2": 0.4,
    ...
  }
}

privacyLevel 3

{
  "externalID": "ok_participant1",
  "sessionID": "abcd1234",
  "timestamp": "2024-01-01T00:00:00Z",
  "groupID": 123456,
  "version": "v1.1.8",
  "mhci": 70.0,
  "subscores": {
    "vision": 65.0,
    "audio": 70.0,
    "transcript": 75.0,
    "assessment": 70.0
  },
  "groupPercentiles": {
    "feature1": 0.5,
    "feature2": 0.4,
    ...
  },
  "userPercentiles": {
    "feature1": 0.5,
    "feature2": 0.4,
    ...
  }
}

privacyLevel 4

{
  "externalID": "ok_participant1",
  "sessionID": "abcd1234",
  "timestamp": "2024-01-01T00:00:00Z",
  "groupID": 123456,
  "version": "v1.1.8",
  "mhci": 70.0,
  "subscores": {
    "vision": 65.0,
    "audio": 70.0,
    "transcript": 75.0,
    "assessment": 70.0
  },
  "groupPercentiles": {
    "feature1": 0.5,
    "feature2": 0.4,
    ...
  },
  "userPercentiles": {
    "feature1": 0.5,
    "feature2": 0.4,
    ...
  },
  "transcript": [
    {
      "role": "assistant",
      "content": "Hello!"
    },
    {
      "role": "user",
      "content": "Hi there!"
    },
    ...
  ]
}

privacyLevel 5

{
  "externalID": "ok_participant1",
  "sessionID": "abcd1234",
  "timestamp": "2024-01-01T00:00:00Z",
  "groupID": 123456,
  "version": "v1.1.8",
  "mhci": 70.0,
  "subscores": {
    "vision": 65.0,
    "audio": 70.0,
    "transcript": 75.0,
    "assessment": 70.0
  },
  "groupPercentiles": {
    "feature1": 0.5,
    "feature2": 0.4,
    ...
  },
  "userPercentiles": {
    "feature1": 0.5,
    "feature2": 0.4,
    ...
  },
  "transcript": [
    {
      "role": "assistant",
      "content": "Hello!"
    },
    {
      "role": "user",
      "content": "Hi there!"
    },
    ...
  ],
  "features": {
    "feature1": 123,
    "feature2": 456,
    ...
  },
}

400

Invalid 'sessionID'

{ "error": "You are missing the path parameter sessionID" }

Session not found

{ "error": "Session not found" }

401: Unauthorized