Skip to main content

Learnster data register: what you can export and how

Every type of data you can export from Learnster, with export method, format, structure and known limitations.

Written by Robin Janevret

This register lists every category of data you can export from Learnster, how to export it, the format and the structure. Use it when you move to another platform or to your own systems.

API paths are relative to https://{instance}.learnster.com/api/public/v4/vendor/{vendor_id} and are documented at developer.learnster.com. The API is included in all plans. Data that is not available via the API can be exported in Studio or on request. Exports on request are handled by your Customer Success Manager and delivered within the 30-day transition period.

Data categories

#

Data category

Export method

Format

Structure / fields

Known limitations

1

Users and user attributes

API GET /users/students/export/ (also /users/students/, /users/students/{student_id}/); User Report in Analytics

JSON; Excel, CSV

Name, email, username, unique ID, title, company, office, country, active, creation date, last login. Teams, managers, tags, sessions, session history, custom attributes and roles are added with the matching include_*=true parameters.

Related data is only returned when the include_* parameters are set.

2

Teams and organisation

API GET /teams/, /teams/{team_id}/members/, /teams/{team_id}/managers/; GET /users/companies/, /users/offices/, /users/titles/

JSON

Teams with members and managers; lists of companies, offices and titles

Teams are the group object; there is no separate departments object.

3

Custom fields

API GET /custom-attributes/, /custom-attributes/{id}/values/

JSON

Field definitions and allowed values. Each learner's values come with the user export (include_custom_attributes=true).

4

Courses and sessions (metadata)

API GET /sessions/, /sessions/{session_id}/; Course Report in Analytics

JSON; Excel, CSV

Session metadata: name, dates, status, settings. The Course Report also includes created date, modified date and last completed date.

Archived sessions are not returned by the API (see row 14).

5

Course content

Exported by Learnster on request via your Customer Success Manager

YAML + original files (see format below)

Course, sessions, session days, events, locations, webinars, certificate settings, completion images, recurring settings, topics, activities, content blocks, activity content, policies, action blocks and the custom messages they send (wording and channel settings)

Not self-service and not in the API. Does not include course categories, rating, author, lecturers, content designers, the selected certificate template, or the course's own notification settings (which reminders are on, recipients and timing). Contains no learner data.

6

Enrollments

API GET /sessions/{session_id}/participants/, /users/students/{student_id}/sessions/, /users/students/{student_id}/sessions/all/; Participant Report in Analytics

JSON; Excel, CSV

Everyone on a session, or every session for one learner

7

Results and progress

API GET /sessions/{session_id}/participants/; Participant Report in Analytics

JSON; Excel, CSV

Per participant: progress, passed, finished date, attended count, certification, manual approval

Inactive enrollments are only available via GET /sessions/completion-history/{session_id}/, with id, session, latest finished date and active.

8

External course history and external certificates

API GET /users/students/{student_id}/history/; User Report column "User course history"; Team External Course History Report (Teams → external courses tab → download)

JSON; Excel, CSV; PDF

Learner, course name, description, provider, completion date, length, expiration date, categories, score. Attached certificate files are downloaded one at a time from the certificate column.

Attached PDFs are not included in the report file and must be downloaded individually.

9

Course certificates

All certificates: exported by Learnster on request via your Customer Success Manager. Single certificates: API GET /users/students/{student_id}/certificates/{session_id}/

PDF files in a ZIP; JSON (API)

One PDF per learner and course, named from the course and the learner's name. The API returns a reference to the certificate file, not the PDF itself.

No self-service bulk download in Studio or the API.

10

Quiz answers

Quiz → Analytics → More menu

Excel, CSV

One row per learner, one column per question

One quiz at a time. Not available via the API.

11

Survey answers

Survey → Analytics → More menu

Excel, CSV

One row per respondent, one column per question

One survey at a time. Anonymous surveys contain no learner names. Not available via the API.

12

Page reactions and written feedback

Page analytics export, per course page

Excel, CSV

Per learner: name, email, reaction (Meaningless / Could be better / Amazing) and written comment

One page at a time. Not available via the API.

13

Uploaded files and media

Download from the Library in Studio

Original file formats

Original files

No API listing or download of the library.

14

Archived sessions and their history

On request: Learnster unarchives the sessions, then they are exported like active ones

YAML (content); JSON, Excel, CSV (enrollments and results)

Content as in row 5; enrollments and results as in rows 6–7

Archived sessions are not in the API until they have been unarchived.

15

Analytics dashboards

Export the underlying reports (rows 1–12)

Excel, CSV

Dashboards are views of data that is also in the standard reports

The dashboard view itself is not exported.

16

Competences and learning paths

Exported by Learnster on request via your Customer Success Manager

JSON or CSV

Title, description, badge, paths and their courses, enrolled learners, settings, and learner progress

Not self-service and not in the API. Courses in the paths are exported separately (rows 4–5).

17

Orchestrator objectives and initiatives

Exported by Learnster on request via your Customer Success Manager

JSON or CSV

Name, description, owners, courses, learners and settings

Not self-service and not in the API.

18

Learner confidence poll answers

Exported by Learnster on request via your Customer Success Manager

JSON or CSV

Each learner's answer on the three-point scale (Meaningless / Could be better / Amazing), per course

Not self-service and not in the API.

19

Orchestrator Insights scores

Not exported separately – recalculate from rows 12 and 18

–

Per objective or initiative: count of Meaningless, Could be better and Amazing answers, and a 0–100 score calculated as ((average − 1) / 2) × 100, where Meaningless = 1, Could be better = 2, Amazing = 3

The Sentiment score is calculated from page reactions (row 12) and the Confidence score from confidence poll answers (row 18). Both can be exported, so the scores can be recalculated with the formula.

20

Workspace configuration: tags, advanced rules (automations) and notification settings

Exported by Learnster on request via your Customer Success Manager

JSON or CSV

Tag list and tag members; advanced rules with conditions, actions, schedule and reversal setting; system and custom messages with text and channel settings

Not self-service and not in the API. Tag names also appear as a column in user and course reports.

21

Audit and activity logs

Not exportable (excluded)

–

–

Excluded from export, see "Data excluded from export" below.

Data excluded from export

The following data cannot be exported, for the reason given:

  • Audit and activity logs – these are security logs. They can contain internal information about how Learnster operates and information about other customers, so sharing them would put the security of the service and other customers' data at risk.

Course content export format

A course export is a folder with three parts:

  • entities.yaml – one YAML document per record, separated by ---, each tagged !entity

  • assets.yaml – one YAML document per file, each tagged !asset

  • assets/ – the files themselves, at the path given in assets.yaml

Each entity has a model (record type), a pk (unique id) and fields. A field that points to another record holds that record's pk. Lesson text, questions and block settings are JSON inside the data field of activity content and the settings field of content blocks. Timestamps use the !time tag. The course image is a file in assets.yaml, not a field on the course.

Example from entities.yaml:

!entity
model: courses.course
pk: 3f1c2a40-1111-2222-3333-444444444444
fields:
name: Onboarding
description: Welcome course
slug: onboarding
settings: null
assets: []
custom_assets: []
---
!entity
model: courses.session
pk: 8ab0e910-5555-6666-7777-888888888888
fields:
name: Onboarding
course: 3f1c2a40-1111-2222-3333-444444444444
active: true
assets: []
custom_assets: []
---
!entity
model: activities.activitycontent
pk: 21c6d000-9999-aaaa-bbbb-cccccccccccc
fields:
content_block: 11aa22bb-3333-4444-5555-666666666666
name: Welcome
points: 1.0
data:
text: Hello
assets: []
custom_assets: []

Example from assets.yaml:

!asset
url: vendors/<vendor>/assets/<file>
file_name: cover.png
to_field: logo
mimetype: image/png
file_type: image
name: Cover
size: 12034
additional_data: {}

Questions

Contact your Customer Success Manager or [email protected], and we will walk you and your new provider through the export.

Did this answer your question?