v8

OpenAPI 3.1.02026-08-033623795.0 MB

Course lesson interactions

Retrieve course lesson interaction

Retrieves the details of an existing course lesson interaction.

Required permissions:

courses:read
course_analytics:read

get/course_lesson_interactions/{id}

Path parameters

idstring required

Example:crsli_xxxxxxxxxxxx

The unique identifier of the lesson interaction to retrieve.

Response

A successful response

completedboolean required

Whether the user has finished this lesson.

created_atstring date-time required

The datetime the lesson interaction was created.

idstring required

The unique identifier for the lesson interaction.

Example response

{
  "course": {
    "experience": {
      "id": "exp_xxxxxxxxxxxxxx"
    },
    "id": "cors_xxxxxxxxxxxxx",
    "title": "Introduction to Technical Analysis"
  },
  "created_at": "2023-12-01T05:00:00.401Z",
  "id": "crsli_xxxxxxxxxxxx",
  "lesson": {
    "chapter": {
      "id": "chap_xxxxxxxxxxxxx"
    },
    "id": "lesn_xxxxxxxxxxxxx",
    "title": "Understanding Candlestick Patterns"
  },
  "user": {
    "id": "user_xxxxxxxxxxxxx",
    "name": "John Doe",
    "username": "johndoe42"
  }
}