xAPI
Mindtickle's read-only Experience API (xAPI) statements endpoint for retrieving learner progress and activity records.
The xAPI category covers Mindtickle’s read-only xAPI statements endpoint for retrieving learner progress and activity records. It applies to all Mindtickle module types and lets external systems, such as a Learning Record Store (LRS) or an enterprise data warehouse, query and extract this data programmatically.
The endpoint returns structured data on module-level engagement. Use the documented Mindtickle progress filters to retrieve records by status: not_started, in_progress, and completed.
Key capabilities
Section titled “Key capabilities”The documented records describe a learning event with the following components:
- Actor: The individual Mindtickle learner performing the action, uniquely identified by email address (
mbox). - Verb: The action taken or the specific progress state achieved by the learner.
- Object: The target learning activity, such as a Mindtickle module or an instructor-led training (ILT) session.
- Timestamp: The precise date and time the learning event occurred.
Prerequisites and shared context
Section titled “Prerequisites and shared context”Mindtickle APIs use OAuth 2.0 authentication. To authorize your request, include a Bearer token in your HTTP header. Generate this token by exchanging your API key and secret key, found in your admin settings, at the authentication endpoint. See Authentication.
Base URLs:
| Region | Base URL |
|---|---|
| Global or standard | https://api.mindtickle.com |
| US region | https://api.prod-us.mindtickle.com |
In this category
Section titled “In this category”- Statements: the xAPI statements resource.
- Get learner progress statements: retrieve statements for a learner, filtered by progress state and paginated.