Tool Use Events

Tool Use events capture the start and end times of sessions within a tool or app, as well as details about the activities performed during those sessions. These events help track how students interact with StudyReel and third-party apps.

Use Tool Use events to monitor time spent on specific activities, measure engagement, and understand which features of your app are being used most frequently.

Example:

{
  "@context": "http://purl.imsglobal.org/ctx/caliper/v1p2", // required
  "id": "uuid", // required
  "type": "ToolUseEvent", // required
  "actor": { // required
    "id": "uuid", // required
    "name": "Jane Doe", // optional
    "role": "Admin" // optional
  },
  "action": "Used", // required
  "object": { // required
    "id": "application-uuid", // required
    "type": "SoftwareApplication" // required
  },
  "eventTime": "2019-11-15T10:15:00.000Z", // required
  "generated": { // required
    "id": "uuid", // required
    "type": "AggregateMeasureCollection", // required
    "items": [ // required
      {
        "id": "uuid", // required
        "type": "PARTICIPATION/INTERACTION/ENGAGEMENT/ANTI_PATTERN", // required
        "metric": "ASSESSMENTS_SUBMITTED/ASSESSMENT_PASSED/MINUTES_ON_TASKS/SKILLS_MASTERED/STANDARDS_MASTERED/UNITS_COMPLETED/UNITS_PASSED/WORDS_READ/CHEATING/RUSHING/IGNORING_EXPLANATION/SKIPPING_RECOMMENDED_LESSON", // required
        "metricValue": "85.0", // optional
        "maxMetricValue": 120.0, // optional
        "startedAtTime": "2024-07-20T10:00:00Z", // required
        "endedAtTime": "2024-07-20T11:00:00Z", // required
        "reasoning": "Tracking time wasted during the module", // required
        "dateCreated": "2024-07-20T10:00:00Z", // required
        "dateModified": "2024-07-20T10:00:00Z" // required
      }
    ]
  },
  "session": { // required
    "id": "session-uuid", // required
    "type": "SESSION" // required
  },
  "federatedSession": { // optional
    "id": "Session-id", // required
    "type": "FEDERATEDSESSION", // required
    "messageParameters": {} // optional - Check the spec
  },
  "context": [ // required
    {
      "type": "Session", // required
      "id": "session-uuid" // required
    },
    {
      "type": "Application", // required
      "id": "application-uuid" // required
    },
    {
      "type": "Enrollment", // required
      "id": "enrollment-uuid", // required
      "name": "John" // optional
    }
  ]
}