Using xAPI labelling to give context to your question data

If you're releasing your course with xAPI tracking, you can enhance your data by adding labels to your questions. Labels provide extra context or categorisation for more meaningful reporting.

There are two types of label you can apply:

  • a custom title to help identify a particular question;
  • and tags to help categorise the data when it is reported to your LRS.

 

Contents

1 xAPI labelling overview

2 Adding xAPI tags and question titles to your questions

3 Example statement

 

xAPI labelling overview

This section explains the two label types in more detail and when you might use them. For instructions on how to add these to your course, see Adding xAPI tags and question titles to your questions.

Question titles

It can sometimes be difficult to tell which question an xAPI statement refers to—especially when there’s more than one question on a page or multiple similarly named pages in your course. This is because xAPI statements follow a core format of actor-verb-object.

For example:

Luci (actor) answered (verb) Page 1 (object)

While the verb shows that a question was answered, it isn't immediately clear which question as the object only refers to the page the action was taken on.

Creating a question title can help you identify which question on that page was answered. The question title doesn't replace the object in the statement, but it is added as additional information in the xAPI data.

You can see an example of a title in the example code at the bottom of this article.

Tags

You can use tags to add categories to your questions to identify things like the learning topics they belong to, the competencies they assess, or the subject matter they cover. This can help you identify trends more easily in your data, allowing you to see where your learners might be struggling or where they are performing well.

You can create as many tags as you need and name them however you like, giving you flexibility in how you categorise your questions.

You can see an example of tags in the example code at the bottom of this article.

 

 

Adding xAPI tags and question titles to your questions

Before you begin

To be able to see the xAPI labels you've added to your questions, you'll need:

  • a Learning Record Store (LRS) to receive xAPI statements
  • a course with xAPI tracking enabled

See Adding xAPI learner tracking to your course for more information.

If you don't have an LRS, you can use SCORM Cloud's built-in LRS to receive xAPI statements from your courses. See Using SCORM Cloud's LRS for xAPI learner data reporting for a full tutorial.

Steps

1. Open your Project

2. Go to the page containing the question(s) you'd like to label with xAPI data

3. Open the question element's edit menu (eluauthor-edit-menu-icon)

eluauthor-project-author-question-edit-menu

 

 

4. Open the Question and answer recording accordion

5. Type in the Question-title field to add a custom question title for your xAPI data.

6. In the Tags field, add your xAPI tags, separating multiple tags with commas.

Only use alphanumeric characters—special characters and symbols aren’t supported.

eluauthor-project-author-xapi-label-tag-fields

7. Select Save to save your changes

8. Repeat for other questions in your course

 

Example statement

How you view the statement itself and how it appears may depend on your LRS. If you're not sure how to view the data, its best to reach out to your LRS's support team first.

For reference, here's an example of what the full xAPI JSON statement might look like. You don't need to understand every part of the code; only the  "context" section of the xAPI statement which contains the extra details you've added.

  • xapi/tags shows the tags you've applied to help categorise the question
  • xapi/title shows the custom question title
{
    "id": "6fdc8641-a5fb-4674-8899-f3cd7ee1d144",
    "actor": {
        "objectType": "Agent",
        "name": "D, Luci",
        "mbox": "mailto:luci@elucidat.com"
    },
    "verb": {
        "id": "http://adlnet.gov/expapi/verbs/answered",
        "display": {
            "en-US": "answered"
        }
    },
    "result": {
        "extensions": {
            "https://app.elucidat.com/xapi/progress": 40
        },
        "score": {
            "scaled": 1
        },
        "completion": false,
        "response": "p15704781aad-answer-1"
    },
    "context": {
        "extensions": {
            "https://app.elucidat.com/xapi/tags": "onboarding,values",
            "https://app.elucidat.com/xapi/title": "What are Elucidat's company values?"
        },
        "registration": "047cb6d2-13c3-11f0-8ae4-0a58a9feac02",
        "contextActivities": {
            "parent": [
                {
                    "id": "https://learning.elucidat.com/course/67e52821e0a52-67e536cf0969a",
                    "objectType": "Activity"
                }
            ],
            "category": [
                {
                    "id": "https://elucidat.com",
                    "definition": {
                        "name": {
                            "en-US": "Elucidat.com"
                        },
                        "description": {
                            "en-US": "Course lovingly crafted with the Elucidat.com rapid authoring tool"
                        }
                    },
                    "objectType": "Activity"
                }
            ]
        }
    },
    "timestamp": "2025-04-07T15:14:51.082Z",
    "stored": "2025-04-07T15:14:54.097Z",
    "authority": {
        "objectType": "Agent",
        "name": "Unnamed Account",
        "account": {
            "name": "7jkTBTB00gLwQGK0dnE",
            "homePage": "http://cloud.scorm.com"
        }
    },
    "version": "1.0.0",
    "object": {
        "id": "https://learning.elucidat.com/course/67e52821e0a52-67e536cf0969a/67e5282d0744a/p1570478197e",
        "definition": {
            "name": {
                "en-US": "Question 1"
            },
            "type": "http://adlnet.gov/expapi/adlnetctivities/cmi.interaction",
            "choices": [
                {
                    "id": "p15704781aad-answer-1",
                    "description": {
                        "en-US": "Learn, Care, Share"
                    }
                },
                {
                    "id": "p15704781aad-answer-2",
                    "description": {
                        "en-US": "Stop, Look, Listen"
                    }
                },
                {
                    "id": "p15704781aad-answer-3",
                    "description": {
                        "en-US": "See it, say it, sorted"
                    }
                }
            ],
            "interactionType": "choice"
        },
        "objectType": "Activity"
    }
}
Was this article helpful?
0 out of 0 found this helpful

Articles in this section

Request support
Access support that’s tailored to you by getting in touch with our Support Team.
Send us feedback
Do you have a new feature request, or want to tell us about something that works well (or not so well) for you? Get in touch!