Skilljar Lesson Progress API
The Lesson Progress API from Skilljar — 1 operation(s) for lesson progress.
OpenAPI Specification
openapi: 3.0.3
info:
title: Skilljar Assets Lesson Progress API
version: 1.0.0
description: 'The Skilljar API provides comprehensive access to our customer education platform, enabling you to programmatically manage courses, users, enrollments, and more.
This interactive documentation is automatically generated from our codebase and stays current with the latest features and endpoints.
## Getting Started
New to the Skilljar API? Check out these essential resources:
- **[API Getting Started Guide](https://support.gainsight.com/Skilljar/Develop_and_Customize/API/Getting_started_with_the_Skilljar_API)** - Authentication, basic concepts, and your first API call
- **[Token-based SSO](https://support.gainsight.com/Skilljar/Develop_and_Customize/Single_Sign_on_(SSO)/Configuring_Token-Based_Single_Sign-On_(SSO))** - Seamlessly integrate user authentication
- **[Webhooks](https://support.gainsight.com/Skilljar/Develop_and_Customize/API/Using_Webhooks_API)** - Real-time notifications for platform events
'
tags:
- name: Lesson Progress
paths:
/v1/lesson-progress/{lesson_progress_id}:
get:
operationId: lesson_progress_retrieve
description: "Retrieve the progress details for a specific lesson progress object.\n\nReturns the current completion status, timestamps, and other progress information for\n the student's lesson attempt."
parameters:
- in: path
name: lesson_progress_id
schema:
type: string
pattern: ^[0-9a-z]+$
required: true
tags:
- Lesson Progress
security:
- OrganizationApiKey: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LessonProgress'
description: ''
put:
operationId: lesson_progress_update
description: 'Update the progress for a specific lesson progress object.
Setting `finished_at` indicates the student as finished the content. This will
also This will also mark the lesson complete unless the lesson requires validation,
such as a review of proctoring. To un-complete the lesson, set `completed_at` to null.
Both PUT and PATCH requests perform partial updates.'
parameters:
- in: path
name: lesson_progress_id
schema:
type: string
pattern: ^[0-9a-z]+$
required: true
tags:
- Lesson Progress
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LessonProgressRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/LessonProgressRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/LessonProgressRequest'
security:
- OrganizationApiKey: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LessonProgress'
description: ''
patch:
operationId: lesson_progress_partial_update
description: 'Partially update the progress for a specific lesson progress object.
Setting `finished_at` indicates the student as finished the content. This will
also This will also mark the lesson complete unless the lesson requires validation,
such as a review of proctoring. To un-complete the lesson, set `completed_at` to null.
Both PUT and PATCH requests perform partial updates.'
parameters:
- in: path
name: lesson_progress_id
schema:
type: string
pattern: ^[0-9a-z]+$
required: true
tags:
- Lesson Progress
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedLessonProgressRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedLessonProgressRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedLessonProgressRequest'
security:
- OrganizationApiKey: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LessonProgress'
description: ''
components:
schemas:
PatchedLessonProgressRequest:
type: object
properties:
finished_at:
type: string
format: date-time
nullable: true
description: ISO 8601 formatted datetime string indicating when the user finished the lesson content. Setting this field will also mark the lesson complete unless the lesson requires validation, such as a review of proctoring.
completed_at:
type: string
format: date-time
nullable: true
description: ISO 8601 formatted datetime string indicating when the user completed the lesson. If null, the user has not completed the lesson.
success_status:
nullable: true
description: '''PASSED'', ''FAILED'' or null
* `PASSED` - Passed
* `FAILED` - Failed'
oneOf:
- $ref: '#/components/schemas/SuccessStatusEnum'
- $ref: '#/components/schemas/NullEnum'
score:
type: integer
maximum: 2147483647
minimum: 0
nullable: true
description: Score received
max_score:
type: integer
maximum: 2147483647
minimum: 0
nullable: true
description: Max possible score
custom_data:
type: string
nullable: true
validation_status:
nullable: true
description: '''PASSED'', ''FAILED'' or null
* `PASSED` - Passed
* `FAILED` - Failed'
oneOf:
- $ref: '#/components/schemas/ValidationStatusEnum'
- $ref: '#/components/schemas/NullEnum'
validation_data:
nullable: true
description: JSON formatted. Ignored if the lesson does not require validation.
LessonProgress:
type: object
properties:
view_count:
type: integer
readOnly: true
last_viewed_on:
type: string
format: date-time
readOnly: true
nullable: true
finished_at:
type: string
format: date-time
nullable: true
description: ISO 8601 formatted datetime string indicating when the user finished the lesson content. Setting this field will also mark the lesson complete unless the lesson requires validation, such as a review of proctoring.
completed_at:
type: string
format: date-time
nullable: true
description: ISO 8601 formatted datetime string indicating when the user completed the lesson. If null, the user has not completed the lesson.
success_status:
nullable: true
description: '''PASSED'', ''FAILED'' or null
* `PASSED` - Passed
* `FAILED` - Failed'
oneOf:
- $ref: '#/components/schemas/SuccessStatusEnum'
- $ref: '#/components/schemas/NullEnum'
score:
type: integer
maximum: 2147483647
minimum: 0
nullable: true
description: Score received
max_score:
type: integer
maximum: 2147483647
minimum: 0
nullable: true
description: Max possible score
custom_data:
type: string
nullable: true
validation_status:
nullable: true
description: '''PASSED'', ''FAILED'' or null
* `PASSED` - Passed
* `FAILED` - Failed'
oneOf:
- $ref: '#/components/schemas/ValidationStatusEnum'
- $ref: '#/components/schemas/NullEnum'
validation_data:
nullable: true
description: JSON formatted. Ignored if the lesson does not require validation.
id:
type: string
readOnly: true
description: Known as lesson_progress_id within the documentation
LessonProgressRequest:
type: object
properties:
finished_at:
type: string
format: date-time
nullable: true
description: ISO 8601 formatted datetime string indicating when the user finished the lesson content. Setting this field will also mark the lesson complete unless the lesson requires validation, such as a review of proctoring.
completed_at:
type: string
format: date-time
nullable: true
description: ISO 8601 formatted datetime string indicating when the user completed the lesson. If null, the user has not completed the lesson.
success_status:
nullable: true
description: '''PASSED'', ''FAILED'' or null
* `PASSED` - Passed
* `FAILED` - Failed'
oneOf:
- $ref: '#/components/schemas/SuccessStatusEnum'
- $ref: '#/components/schemas/NullEnum'
score:
type: integer
maximum: 2147483647
minimum: 0
nullable: true
description: Score received
max_score:
type: integer
maximum: 2147483647
minimum: 0
nullable: true
description: Max possible score
custom_data:
type: string
nullable: true
validation_status:
nullable: true
description: '''PASSED'', ''FAILED'' or null
* `PASSED` - Passed
* `FAILED` - Failed'
oneOf:
- $ref: '#/components/schemas/ValidationStatusEnum'
- $ref: '#/components/schemas/NullEnum'
validation_data:
nullable: true
description: JSON formatted. Ignored if the lesson does not require validation.
SuccessStatusEnum:
enum:
- PASSED
- FAILED
type: string
description: '* `PASSED` - Passed
* `FAILED` - Failed'
ValidationStatusEnum:
enum:
- PASSED
- FAILED
type: string
description: '* `PASSED` - Passed
* `FAILED` - Failed'
NullEnum:
enum:
- null
securitySchemes:
OrganizationApiKey:
type: http
scheme: basic
description: API key authentication using HTTP Basic Auth. Use your API key as the username and leave password empty.
tokenAuth:
type: http
scheme: bearer