Initialization Option Items API

session_metadata

Custom metadata to include for the learner's assessment session. This metadata is stored when the session is saved or submitted and contains custom data that you have configured that is related to the current session.

You would want to use this option so that you can set your own custom metadata information for the current session.

Examples

// Standard usage
var initializationOptions = {
    "session_metadata": {
        "my_attribute_1": "...",
        "my_attribute_2": 1234,
        // ...
    }
    // ...
};

// Usage with Reports API: Sessions Detail by Item Report
var initializationOptions = {
    "session_metadata": {
        "session_tags": [
            {
                "type": "assignment_type",
                "name": "homework"
            },
            // ...
        ]
    }
    // ...
};

Values

Request object key session_metadata

Type object

Related articles

Was this article helpful?