Functions in Hype xAPI
...
HypeXAPI
HypeXAPI.setDefault

result

2min

There are four different types of results that can be used in the result branch of an xAPI statement: score, success, completion, and response. Score results are typically used to track a learner's progress on a scale, such as a quiz with 100 possible points. Success results are used to track whether or not a learner was successful in completing a task, such as completing a quiz with a passing grade. Completion results are used to track whether or not a learner has completed a task, such as reading a document. Response results are used to track a learner's answer to a question, such as choosing the correct answer to a multiple-choice question. The most common type of result used is the score result, followed by the success, completion, and response results.

JS


In case of results, using dynamic data is really helpful, as functions can be used on keys like the success key of an xAPI statement in order to dynamically track whether or not a learner was successful in completing a task. This is useful for tasks that have variable success criteria, such as a game that has different levels of difficulty. By using a function on the success key, the xAPI statement can be tailored to the specific task that was attempted, ensuring that the correct data is being tracked.

JS




Updated 25 Mar 2024
Doc contributor
Did this page help you?