xAPI Course Builder Profile (v1.0)

This xAPI Profile defines the statements sent by every course built with xAPI Course Builder:

Course progress: opened, started, completed, and each lesson viewed
Questions: true/false, choice, hotspot, drag-and-drop, sequencing and free-text answers, as cmi.interaction activities
Assessments: scored sections reported as passed or failed against a pass mark
Feedback: star ratings and comments, following the Feedback Interaction Profile
Video: playback following the ADL xAPI Video Profile v1.0.3
Audio: playback following the ADL xAPI Audio Profile v1.0

Profile IRI: https://xapi.com.au/profiles/course-builder
Version IRI: https://xapi.com.au/profiles/course-builder/v1.0

You can download the machine-readable version of the profile here:

Download profile.jsonld (JSON-LD)

Identifying statements

Every statement names this profile version as a category context activity. Video and audio statements also name the ADL Video or Audio Profile.

"context": { "contextActivities": { "category": [
{
    "id": "https://xapi.com.au/profiles/course-builder/v1.0",
    "definition": {
        "type": "http://adlnet.gov/expapi/activities/profile"
    }
}
] } }

Each statement matches exactly one template, by its verb and object activity type. Unless a template says otherwise, every statement also:

has a timestamp, and a context.registration when the course is launched with one;
carries the course's published version in the version context extension;
has the course activity as its parent, unless the statement is about the course itself.

Activity ids are built from the course activity id given at launch: …/lesson/{id}, …/section/{id} for assessments, and …/block/{id} for questions, feedback and media.

Statement templates

Extension names are shortened. Hover over one for its full IRI, or see the JSON-LD.

Course and lessons

Statement	Verb / activity type	Must include
Course initialized The learner opened the course.	`initialized` `course`	Common rules only
Course started The learner started the course for the first time in this registration.	`start` `course`	Common rules only
Course completed Every lesson viewed and every graded block passed. result.success is whether all graded questions were passed.	`completed` `course`	`result.completion` = `true` Recommended: `result.success`
Lesson experienced The learner viewed a lesson. The latest one is read back to resume the course.	`experienced` `lesson`	Common rules only

Questions and assessments

Statement	Verb / activity type	Must include
Question answered Each answer submitted to a question or free-text block. Choice-style responses use the CMI [,] / [.] separators; graded questions also carry result.success.	`answered` `cmi.interaction`	`result.response` `object.definition.interactionType`
Question passed Sent with question-answered when the answer is correct.	`passed` `cmi.interaction`	`result.response` `object.definition.interactionType` `result.success` = `true`
Question failed Sent with question-answered when the answer is wrong.	`failed` `cmi.interaction`	`result.response` `object.definition.interactionType` `result.success` = `false`
Assessment passed A scored assessment section was submitted and met its pass mark (cmi5 masteryscore, 0-1).	`passed` `assessment`	`result.success` = `true` `result.completion` = `true` `result.score.scaled` `result.score.raw` `result.score.max` `context.extensions.masteryscore` `result.extensions.answers`
Assessment failed A scored assessment section was submitted below its pass mark.	`failed` `assessment`	`result.success` = `false` `result.completion` = `true` `result.score.scaled` `result.score.raw` `result.score.max` `context.extensions.masteryscore` `result.extensions.answers`

Feedback

Statement	Verb / activity type	Must include
Feedback rated A star rating (0-5, half stars) from a feedback block (Feedback Interaction Profile).	`rated` `feedback`	`result.score.raw` `result.extensions.star-rating`
Feedback commented A written comment from a feedback block, sent before its rating (Feedback Interaction Profile).	`commented` `feedback`	`result.response` `result.extensions.comment-text`

Video

Statement	Verb / activity type	Must include
Video initialized The video player loaded and is ready.	`initialized` `video`	`context.contextActivities.category[*].id` includes `https://w3id.org/xapi/video` `context.extensions.session-id` `context.extensions.length` Recommended: `context.extensions.completion-threshold`
Video played Playback started or resumed.	`played` `video`	`context.contextActivities.category[*].id` includes `https://w3id.org/xapi/video` `context.extensions.session-id` `result.extensions.time` Recommended: `context.extensions.completion-threshold`, `context.extensions.length`
Video paused Playback paused.	`paused` `video`	`context.contextActivities.category[*].id` includes `https://w3id.org/xapi/video` `context.extensions.session-id` `context.extensions.length` `result.extensions.time` `result.extensions.progress` `result.extensions.played-segments` Recommended: `context.extensions.completion-threshold`
Video seeked The learner moved the playhead.	`seeked` `video`	`context.contextActivities.category[*].id` includes `https://w3id.org/xapi/video` `context.extensions.session-id` `result.extensions.time-from` `result.extensions.time-to` Recommended: `context.extensions.completion-threshold`, `context.extensions.length`
Video completed The learner played enough of the video to meet its completion threshold. At most once per session.	`completed` `video`	`context.contextActivities.category[*].id` includes `https://w3id.org/xapi/video` `context.extensions.session-id` `context.extensions.length` `result.extensions.time` `result.extensions.progress` `result.extensions.played-segments` `result.completion` = `true` `result.duration` Recommended: `context.extensions.completion-threshold`
Video terminated The learner left the media; ends the session.	`terminated` `video`	`context.contextActivities.category[*].id` includes `https://w3id.org/xapi/video` `context.extensions.session-id` `context.extensions.length` `result.extensions.time` `result.extensions.progress` `result.extensions.played-segments` Recommended: `context.extensions.completion-threshold`
Video interacted Full screen, volume, speed or captions changed: carries the full-screen + screen-size + video-playback-size, volume, speed, or cc-enabled + cc-subtitle-lang context extensions (Video Profile screenchange, volumechange, closed-captioning).	`interacted` `video`	`context.contextActivities.category[*].id` includes `https://w3id.org/xapi/video` `context.extensions.session-id` `result.extensions.time` Recommended: `context.extensions.completion-threshold`

Audio

Statement	Verb / activity type	Must include
Audio initialized The audio player loaded and is ready.	`initialized` `audio`	`context.contextActivities.category[*].id` includes `https://w3id.org/xapi/audio` `context.extensions.session-id` `context.extensions.length` Recommended: `context.extensions.completion-threshold`
Audio played Playback started or resumed.	`played` `audio`	`context.contextActivities.category[*].id` includes `https://w3id.org/xapi/audio` `context.extensions.session-id` `result.extensions.time` Recommended: `context.extensions.completion-threshold`, `context.extensions.length`
Audio paused Playback paused.	`paused` `audio`	`context.contextActivities.category[*].id` includes `https://w3id.org/xapi/audio` `context.extensions.session-id` `context.extensions.length` `result.extensions.time` `result.extensions.progress` `result.extensions.played-segments` Recommended: `context.extensions.completion-threshold`
Audio seeked The learner moved the playhead.	`seeked` `audio`	`context.contextActivities.category[*].id` includes `https://w3id.org/xapi/audio` `context.extensions.session-id` `result.extensions.time-from` `result.extensions.time-to` Recommended: `context.extensions.completion-threshold`, `context.extensions.length`
Audio completed The learner played enough of the audio to meet its completion threshold. At most once per session.	`completed` `audio`	`context.contextActivities.category[*].id` includes `https://w3id.org/xapi/audio` `context.extensions.session-id` `context.extensions.length` `result.extensions.time` `result.extensions.progress` `result.extensions.played-segments` `result.completion` = `true` `result.duration` Recommended: `context.extensions.completion-threshold`
Audio terminated The learner left the media; ends the session.	`terminated` `audio`	`context.contextActivities.category[*].id` includes `https://w3id.org/xapi/audio` `context.extensions.session-id` `context.extensions.length` `result.extensions.time` `result.extensions.progress` `result.extensions.played-segments` Recommended: `context.extensions.completion-threshold`
Audio interacted Volume changed (Audio Profile volumechange).	`interacted` `audio`	`context.contextActivities.category[*].id` includes `https://w3id.org/xapi/audio` `context.extensions.session-id` `result.extensions.time` `context.extensions.volume` Recommended: `context.extensions.completion-threshold`

Patterns

Course attempt (per registration): opens with Course initialized, which is sent again on every relaunch, followed by any of the statements above. Course started is sent once, and Course completed once the course's requirements are met.
Video session and Audio session (per session-id): initialized, then any of played, paused, seeked, interacted and completed, then exactly one terminated. This is the ADL Video and Audio Profiles' general pattern. Video sends completed once, when 95% has been watched (the completion-threshold extension).

Concepts defined by this profile

Course version (ContextExtension): https://w3id.org/xapi/course-builder/extensions/version
The published version label of the course that sent the statement. The player reads it back to decide whether a saved place or assessment result still applies.
Assessment answers (ResultExtension): https://w3id.org/xapi/course-builder/result-extensions/answers
On a scored assessment's passed/failed statement: each question block id mapped to whether the learner's first answer was correct.

Everything else is reused from other profiles. Verbs:

http://adlnet.gov/expapi/verbs/initialized
http://activitystrea.ms/schema/1.0/start
http://adlnet.gov/expapi/verbs/completed
http://adlnet.gov/expapi/verbs/experienced
http://adlnet.gov/expapi/verbs/answered
http://adlnet.gov/expapi/verbs/passed
http://adlnet.gov/expapi/verbs/failed
https://w3id.org/xapi/acrossx/verbs/rated
https://w3id.org/xapi/adb/verbs/commented
https://w3id.org/xapi/video/verbs/played
https://w3id.org/xapi/video/verbs/paused
https://w3id.org/xapi/video/verbs/seeked
http://adlnet.gov/expapi/verbs/terminated
http://adlnet.gov/expapi/verbs/interacted

Activity types:

http://adlnet.gov/expapi/activities/course
http://adlnet.gov/expapi/activities/lesson
http://adlnet.gov/expapi/activities/cmi.interaction
http://adlnet.gov/expapi/activities/assessment
https://xapi.com.au/activities/feedback
https://w3id.org/xapi/video/activity-type/video
https://w3id.org/xapi/audio/activity-type/audio

Per-course profiles

Each exported course package includes its own xapi-profile.jsonld, which contains just the templates and patterns that course's blocks use. Alongside it, xapi-activities.json lists each lesson, assessment and tracked block, with the templates it sends.