Understanding xAPI

The Apex data reporting system is built on the Experience API (xAPI) technical specification. We will touch on elements of the specification in this documentation, but a good introduction can be found at the Devlin Peck website. Or you can check out the official specification on github.

While this SDK will generate fully compliant xAPI statements when reporting to Apex, many of the statement properties can (and should) be automatically be set by the SDK. For example, the Actor property of any Apex data report will default to the logged in user. In the next section we will go over some of the most common elements found in an xAPI report that might get sent to Apex (check out the official xAPI spec for a comprehensive breakdown).

Last updated