Publish Events

Apps can also send their own custom Caliper events to StudyReel using a provided API endpoint. This ensures that StudyReel has a complete view of the student's interactions, even those occurring directly within your app.

To send events, use the following endpoint:

HTTP Method: POST

Base Production URL: https://prod-studyreel.alpha1edtech.com/

Base Staging URL: https://studyreel.alpha1edtech.com/

Endpoint URL: /events

Request body

The request body will be same as the Caliper event you’d like to send, with your toolId set as the Object ID. Example:

{
  "@context": "http://purl.imsglobal.org/ctx/caliper/v1p2",
  ...
  ...
  "object": {
      "id": "6e55fa37-66d5-4bd7-868a-4c41d3ed427f",
      "type": "StudyReel Tool"
      },
  ...
}
// truncated for readability

Response

201

{
  "success": true
}

400

401

500

Capturing multiple behaviors

If a student exhibits different kinds of behavior during their time in your app, you can capture them by publishing multiple Tool Use events. For example, to capture Antipatterns during engaged learning durations, you can have an engagement event such as:

{
  "@context": "http://purl.imsglobal.org/ctx/caliper/v1p2",
  "id": "uuid",
  "type": "ToolUseEvent",
  "action": "Used",
    "items": [
      {
        "id": "uuid",
        "type": "ENGAGEMENT",
        "metric": "UNITS_COMPLETED",
        "metricValue": "3",
        "startedAtTime": "2024-07-20T10:00:00Z", // required
        "endedAtTime": "2024-07-20T11:00:00Z", // required
      }
    ]
  },
// truncated for readability

As well as an Antipattern event with start and end times in the same range, such as :

{
  "@context": "http://purl.imsglobal.org/ctx/caliper/v1p2",
  "id": "uuid",
  "type": "ToolUseEvent",
  "action": "Used",
    "items": [
      {
        "id": "uuid",
        "type": "ANTI_PATTERN",
        "metric": "RUSHING",
        "metricValue": "7",
        "startedAtTime": "2024-07-20T10:28:00Z", // required
        "endedAtTime": "2024-07-20T10:35:00Z", // required
      }
    ]
  },
// truncated for readability

Triggering tool use events

You can implement various methods of publishing such event data-

1. Time-based: Send events at regular intervals (e.g., every 1-5 minutes)

2. Action-based: Trigger on specific user actions (e.g., tab switches)

3. Custom logic: Implement app-specific event transmission rules