E-Learning Ingest Events

Kenkai SDK E-Learning module consists of events for online learning platforms. You need to implement this module if your app offers learning content that may include learning content, viewing courses, attempting exams, or passing an exam to get certified.

List of Events

Event Name	Type	Description
Question	question	Track actions on user activity on a given question.
Exam	exam	Track events user performed while attempting the exam.
Module	module	Track events regarding user interaction with the module inside the app.

---

Question Event

To log user answers to the questions. To log this event you need to provide the question id that User has attempted and also the id for the answer the user has selected.

Format

Param	Usability	Format	Enum Values	Description
question_id	REQUIRED	STRING	---	Id for the question.
action	REQUIRED	STRING	answer, skip	Action applied on the question.
answer_id	REQUIRED	STRING	---	Id for the answer from a group of questions.
exam_id	REQUIRED	STRING	---	Id for the exam for which the question is a part of.
meta	OPTIONAL	ANY	---	Any additional value that is sent with the log.

Usage

Android (Java/Kotlin)

    val questionObject1 = QuestionObject(
        id = "testQuestionId",
        examId = "testExamId",
        action = QuestionAction.Skip
    )

    CFELearnEvent.logIngest(
        eventType = ELearnEventType.Question,
        logObject = questionObject
    )

iOS (Swift)

    let questionObject = QuestionObject(
        id: "tQuestionId", 
        examId: "teExamId", 
        action: .Skip, 
        answerId: "someAnswer"
    )

    CFELearnEvent.shared.logIngest(eventType: .Question, logObject: questionObject)

React Native (JS/TS)

    let questionProperties = {
        question_id: "testQuestionId",
        exam_id: "testExamId",
        action: QuestionAction.Answer,
        answer_id: "testAnswerId",
    }

    CFElearn.logIngestEvent(
      ELearnEventType.Question,
      questionProperties,
      false,
    );

Web Application (JS/TS)

    let questionProperties = {
        question_id: "testQuestionId",
        exam_id: "testExamId",
        action: QuestionAction.Answer,
        answer_id: "testAnswerId",
    }

    ELearning.logIngestEvent(
        ELearningTypes.Question,
        questionProperties
    );

JSON

{
    "name": "question",
    "property": "skip",
    "ctx": {
        "__ol": true,
        "action": "skip",
        "exam_id": "testExamId",
        "question_id": "testQuestionId"
    },
        }

---

Exam Event

To log actions related to e-learning module exams. which includes the related to starting, retaking, reviewing and submit the exam. BsLogExamEvent also updates the user level if they achieved a milestone.

Format

Param	Usability	Format	Enum Values	Description
exam_id	REQUIRED	STRING	---	Id for the exam provided to user.
action	REQUIRED	STRING	start, submit, result	Action applied on the exam by the user.
is_passed	REQUIRED	BOOLEAN	---	If the user passed the exam or not?
score	REQUIRED	FLOAT	---	Total score the user achieved in the exam.
duration	REQUIRED	INT	---	Time in seconds, user spent on the exam.
meta	OPTIONAL	ANY	---	Any additional value that is sent with the log.

Usage

Android (Java/Kotlin)

    val examObject = ExamObject(
        id = "exam_exam_id",
        score = 90f,
        isPassed = true,
        action = ExamAction.Start,
    )

    CFELearnEvent.logIngest(
        eventType = ELearnEventType.Exam,
        logObject = examObject
    )

iOS (Swift)

    let examObject = ExamObject(
        id: "exam_exam_id", 
        action: .Submit, 
        duration: 100
    )

    CFELearnEvent.shared.logIngest(eventType: .Exam, logObject: examObject)

React Native (JS/TS)

    let examResultProperties = {
        exam_id: "testExamId",
        action: ExamAction.Result,
        score: 80,
        is_passed: true,
    }

    CFElearn.logIngestEvent(ELearnEventType.Exam, examProperties, false);

Web Application (JS/TS)

    let examResultProperties = {
        exam_id: "testExamId",
        action: ExamAction.Result,
        score: 80,
        is_passed: true,
    }

    ELearning.logIngestEvent(
        ELearningTypes.Exam,
        examProperties
    );

JSON

{
    "name": "exam",
    "property": "start",
    "ctx": {
        "__ol": true,
        "action": "start",
        "exam_id": "exam_exam_id",
        "is_passed": "true",
        "score": "90.0"
    },
}

---

Module Event

To log actions related to e-learning modules which includes the log for user viewing the module, starting and finishing the module and also user viewing the content page as well.

Format

Param	Usability	Format	Enum Values	Description
module_id	REQUIRED	STRING	---	Id for the module user is interacting.
action	REQUIRED	STRING	view	Action user if performing while interacting with the module.
progress	OPTIONAL	INT	---	Progress of user towards completing the module.
meta	OPTIONAL	ANY	---	Any additional value that is sent with the log.

Usage

Android (Java/Kotlin)

    val moduleObject = ModuleObject(
        id = "testModuleId",
        progress = 60,
        action = ModuleLogAction.View
    )

    CFELearnEvent.logIngest(
        eventType = ELearnEventType.Module,
        logObject = moduleObject
    )

iOS (Swift)

    let moduleObject = ModuleObject(
        id: "testModuleId", 
        progress: 70, 
        action: .View
    )
    
    CFELearnEvent.shared.logIngest(eventType: .Module, logObject: moduleObject)

React Native (JS/TS)

    let moduleProperties = {
        module_id: "testModuleId",
        action: ModuleAction.View,
        progress: 90,
    }

    CFElearn.logIngestEvent(ELearnEventType.Module, moduleProperties, false);

Web Application (JS/TS)

    let moduleProperties = {
        module_id: "testModuleId",
        action: ModuleAction.View,
        progress: 90,
    }
    
     ELearning.logIngestEvent(
        ELearningTypes.Module,
        moduleProperties
    );

JSON

{
    "name": "module",
    "property": "view",
    "ctx": {
        "__ol": true,
        "action": "view",
        "module_id": "testModuleId",
        "progress": "60.0"
    },
}

---