Completions Export Integration

Completion Event

A completion event in the scope of the Cybrary is when a user completes an activity that is within the view of the organization. The following types of content will generate completion events tracked in this integration: 

• Course

• Lab

• Assessment

• Career Path

Credentials and Access

Completion exports can be accessed via API

API Access

OAuth Credentials will be provided by Cybrary

Access Token URL: https://app.cybrary.it/auth/oauth/token

Scope: "use-integrations"

Client Authentication should be Basic Auth Header

Available Methods

Export List Format

[
  {
    "date":"01_25_2020",
    "url":"https://app.cybrary.it/courses/api/integrations/completions/01_25_2020"
  },
  {// ... //}
]

Export Format

Data will be delivered in JSON format as an array of objects in which each object will contain a set of XAPI statements that are relevant for each instance of a completion event.

Files will be named as follows: xapi_completion_export_DD_MM_YYYY.json

DD_MM_YYYY would represent the date that the file covers the export for, e.g. xapi_completion_export_22_01_2020.json

A single file will be generated for each day. The file will contain data for events that have happened on that date in UTC time zone. This may include completions for past dates.

[{
  "timestamp": "2019-11-13T16:07:23.726Z",
  "actor": {
    "name": "John Doe",
    "mbox": "mailto:user@example.com"
    "account": {
      "homePage": "https://www.cybrary.it/",
      "name": "1985071"
    }
  },
  "verb": {
    "id": "http://adlnet.gov/expapi/verbs/completed",
    "display": {
      "en-US": "completed"
    }
  },
  "result": {
    "completion": true,
    "success": true
  },
  "object": {
  "id": "https://www.cybrary.it/course/intro-to-data-science/",
  "definition": {
    "type": "http://adlnet.gov/expapi/activities/course",
    "name": {
     "en-US": "Intro to Data Science"
      },
      "extensions": {
        "https://www.cybrary.it/contentDescriptionId": "8793",
        "https://www.cybrary.it/continuingEducationUnits": 4,
        "https://www.cybrary.it/learningHours": 3.449
      }
    }
  }
},
{
   //// Next Statement ///

}]

Field Descriptions

If you have any questions, please contact your dedicated Customer Success Manager for assistance.