When designing xAPI statements, examples can be useful. This guide showcases example statements used to power a selection of reports from Watershed's demo environment. These aren't intended to be perfect exemplar statements, but point you in the right direction to get started.

Activity Report

The Activity report reports on assessment or quiz completion, success, score and time taken, plus the details of responses to individual questions. 

The statements below represent a question submission and completing the assessment as a whole. 

{
  "id": "10b61f89-f522-42cb-bf03-77fac0780e49",
  "actor": {
    "objectType": "Agent",
    "mbox": "mailto:Rosaura.Dorn@example.com"
  },
  "verb": {
    "id": "http://adlnet.gov/expapi/verbs/answered",
    "display": {}
  },
  "object": {
    "objectType": "Activity",
    "id": "http://example.csat.assessment.example.com/question/1",
    "definition": {
      "name": {
        "en-US": "Which of the following does not show active listening?"
      },
      "interactionType": "choice",
      "correctResponsesPattern": [
        "asking"
      ],
      "choices": [
        {
          "id": "repeating",
          "description": {
            "en-US": "Repeating and reflecting back your understanding to the customer"
          }
        },
        {
          "id": "asking",
          "description": {
            "en-US": "Asking your manager to speak with the customer"
          }
        },
        {
          "id": "notes",
          "description": {
            "en-US": "Making notes"
          }
        },
        {
          "id": "words",
          "description": {
            "en-US": "Using words such as, I see, go on, right"
          }
        }
      ]
    }
  },
  "result": {
    "success": false,
    "completion": true,
    "duration": "PT01M00S",
    "response": "notes",
    "durationCentiseconds": 6000
  },
  "context": {
    "registration": "9e1659a8-e48f-47f2-8fe4-05cd12ee6646",
    "contextActivities": {
      "parent": [
        {
          "objectType": "Activity",
          "id": "http://example.csat.assessment.example.com",
          "definition": {
            "name": {
              "en-US": "CSAT Assessment"
            }
          }
        }
      ]
    }
  },
  "timestamp": "2017-12-22T03:32:01.455Z",
  "stored": "2018-03-22T03:36:56.628Z",
  "authority": {
    "objectType": "Agent",
    "name": "LMS",
    "account": {
      "homePage": "http://example.com",
      "name": "example lms"
    }
  },
  "version": "1.0.1"
}

{
  "id": "b050bf5d-58f0-462e-8820-ac7857fa8c93",
  "actor": {
    "objectType": "Agent",
    "mbox": "mailto:Tobie.Staggs@example.com"
  },
  "verb": {
    "id": "http://adlnet.gov/expapi/verbs/failed",
    "display": {}
  },
  "object": {
    "objectType": "Activity",
    "id": "http://example.csat.assessment.example.com",
    "definition": {
      "name": {
        "en-US": "CSAT Assessment"
      }
    }
  },
  "result": {
    "score": {
      "scaled": 0.46,
      "raw": 46.0
    },
    "success": false,
    "completion": true,
    "duration": "PT25M00S",
    "durationCentiseconds": 150000
  },
  "context": {
    "registration": "07056849-0d9f-4c23-89a1-98cdcb05fc3c",
    "contextActivities": {
      "parent": [
        {
          "objectType": "Activity",
          "id": "http://example.csat.assessment.example.com",
          "definition": {
            "name": {
              "en-US": "CSAT Assessment"
            }
          }
        }
      ]
    }
  },
  "timestamp": "2017-12-22T03:57:01.414Z",
  "stored": "2018-03-22T03:36:56.326Z",
  "authority": {
    "objectType": "Agent",
    "name": "LMS",
    "account": {
      "homePage": "http://example.com",
      "name": "example lms"
    }
  },
  "version": "1.0.1"
}

Program Report

The Program report shows on progress towards configured milestones.

{
  "id": "90ace6d8-cb09-4125-9263-e1cf98ae244b",
  "actor": {
    "objectType": "Agent",
    "mbox": "mailto:Kathlene.Morse@example.com"
  },
  "verb": {
    "id": "http://adlnet.gov/expapi/verbs/passed",
    "display": {}
  },
  "object": {
    "objectType": "Activity",
    "id": "http://program.module-1-test-out.example.com",
    "definition": {
      "name": {
        "en-US": "Module 1 (Test Out)"
      },
      "type": "http://adlnet.gov/expapi/activities/assessment"
    }
  },
  "result": {
    "score": {
      "scaled": 0.98
    },
    "success": true,
    "completion": true,
    "duration": "PT02H00M00S",
    "durationCentiseconds": 720000
  },
  "timestamp": "2017-08-10T03:32:00.772Z",
  "stored": "2018-03-22T03:35:14.526Z",
  "authority": {
    "objectType": "Agent",
    "name": "LMS",
    "account": {
      "homePage": "http://example.com",
      "name": "example lms"
    }
  },
  "version": "1.0.1"
}

Leaderboard Report

The Leaderboard report can be used with a variety of measures and metrics. The example below shows the popularity of different search terms.

{
  "id": "c53fb011-aae4-425d-a01f-e5687b364346",
  "actor": {
    "objectType": "Agent",
    "mbox": "mailto:Alecia.Beach@example.com"
  },
  "verb": {
    "id": "http://activitystrea.ms/schema/1.0/search",
    "display": {
      "en-US": "searched on"
    }
  },
  "object": {
    "objectType": "Activity",
    "id": "http://video.portal.example.com/search",
    "definition": {
      "name": {
        "en-US": "Video search page"
      },
      "type": "http://activitystrea.ms/schema/1.0/page"
    }
  },
  "result": {
    "response": "customer service"
  },
  "timestamp": "2017-08-10T03:32:00.247Z",
  "stored": "2018-03-22T03:33:51.654Z",
  "authority": {
    "objectType": "Agent",
    "name": "Content Portal",
    "account": {
      "homePage": "http://example.com",
      "name": "content portal"
    }
  },
  "version": "1.0.1"
}