BI Connector: Data Dictionary

Follow

The BI Connector provides customers with direct access to learner data. The following tables are currently supported via Postgres SQL. Refer to the PDF for full details: Data Dictionary updated: 11/13/2017 

Common Fields

There are a few common fields on all tables.

Primary ID

Each table has a primary ID field.  The ID is an alphanumeric (lowercase) field up to 32 characters long.  The value of the ID is unique across all instances of the particular table, but not necessarily globally unique across all IDs within Skilljar.

Naming of the primary ID field is typically the table name suffixed with “_id”.

Created At

The “created_at” field is a datetime indicating when the given row was created within Skilljar.

Tables

certificate

Field name

Format

Length

Description

created_at

datetime

 

timestamp of when the object was created

certificate_id

char

varying(32)

unique id of the certificate

code

char

varying(12)

unique code for the certificate used to create a public url

completed_at

datetime

 

timestamp when the certificate was completed

expires_at

datetime

 

timestamp for when the certificate will expire

url

char

varying(255)

public url to access the certificate

 

course

Field name

Format

Length

Description

created_at

datetime

 

timestamp of when the object was created

course_id

char

varying(32)

unique id of the course

title

char

varying(500)

title of the course

 

course_series

Field name

Format

Length

Description

created_at

datetime

 

timestamp of when the object was created

course_series_id

char

varying(32)

unique id of the course series

domain_id

char

varying(32)

unique id of the domain on which the course series belongs

title

char

varying(500)

title of the course series

visible_on_catalog

bool

 

whether or not the course series is visible on the catalog page (True/False)

 

course_series_published_courses

Field name

Format

Length

Description

created_at

datetime

 

timestamp of when the object was created

course_series_published_course_id

char

varying(32)

unique id of the course_series_published_course

course_series_id

char

varying(32)

unique id of the course series

published_course_id

char

varying(100)

unique id of the published course in the series

 

domain

Field name

Format

Length

Description

created_at

datetime

 

timestamp of when the object was created

domain_id

char

varying(32)

unique id of the domain

name

char

varying(225)

domain name

 

domain_access_code

Field name

Format

Length

Description

created_at

datetime

 

timestamp of when the object was created

domain_access_code_id

char

varying(32)

unique id of the access code

code

char

varying(255)

value of the access code

use_count

int

 

how many times the access code has been used

max_uses

int

 

how many times the access code can be used total

is_active

bool

 

whether or not the access code is active and can be used (True/False)

domain_access_code_pool_id

char

varying(32)

unique id of the access code pool the access code belongs to

 

domain_access_code_pool

Field name

Format

Length

Description

created_at

datetime

 

timestamp of when the object was created

domain_access_code_pool_id

char

varying(32)

unique id of the access code pool

name

char

varying(255)

the name of the access code pool

domain_id

char

varying(32)

unique id of the domain the access code pool belongs to

 

domain_membership

Field name

Format

Length

Description

created_at

datetime

 

timestamp of when the object was created

domain_membership_id

char

varying(32)

unique id of the domain membership

is_active

bool

 

whether or not the domain membership is active

expires_at

datetime

 

timestamp when the domain membership will expire

domain_id

char

varying(32)

unique id of the domain

domain_access_code_id

char

varying(32)

unique id of the access code

student_id

char

varying(32)

unique id of the student

 

domain_signup_field

Field name

Format

Length

Description

created_at

datetime

 

timestamp of when the object was created

domain_signup_field_id

char

varying(32)

unique id of the signup field

label

char

varying(100)

name of the signup field

domain_id

char

varying(32)

unique id of the domain the signup field belongs to

 

domain_signup_info

This table represents an individual student’s response of a signup field.

 

Field name

Format

Length

Description

created_at

datetime

 

timestamp of when the object was created

domain_signup_info_id

char

varying(32)

unique id of the signup info

value

char

varying(100)

the customer value provided for the signup info

domain_membership_id

char

varying(32)

unique id of the domain membership the signup info belongs to

domain_signup_field_id

char

varying(32)

unique id of the signup field the signup info belongs to



enrollment

Field name

Format

Length

Description

created_at

datetime

 

timestamp of when the object was created

enrollment_id

char

varying(32)

unique id for the enrollment

enrolled_at

datetime

 

timestamp of when the student first became enrolled in the course

expires_at

datetime

 

timestamp of when the course enrollment expires

is_active

bool

 

whether or not the student has access to the published course from this enrollment

certficate_id

char

varying(32)

unique id of the certificate earned for the course

published_course_id

char

varying(32)

unique id of the published course enrolled in

purchase_id

char

varying(32)

unique id of the purchase this enrollment corresponds to

student_id

char

varying(32)

unique id of the student

student_course_progress_id

char

varying(32)

unique id of the student course progress

 

lesson

Field name

Format

Length

Description

created_at

datetime

 

timestamp of when the object was created

lesson_id

char

varying(32)

unique id of the lesson

is_section

bool

 

indicates whether the lesson is a section/header

type

char

varying(12)

the type of the lesson (Text, Quiz, etc.)

title

char

varying(500)

the title of the lesson

order

int

 

the order in which this lesson appears within the course

course_id

char

varying(32)

unique id of the course

quiz_id

char

varying(32)

unique id of the quiz (if applicable)

web_package_id

char

varying(32)

unique id of the web package (if applicable)

 

offer

Field name

Format

Length

Description

created_at

datetime

 

timestamp of when the object was created

offer_id

char

varying(32)

unique id of the offer

domain_id

char

varying(32)

unique id of the domain this offer belongs to

published_course_id

char

varying(32)

unique id of the published_course this offer belongs to

course_series_id

char

varying(32)

unique id of the course_series this offer belongs to

offer_type

char

varying(32)

unique id of the published_course this offer belongs to

price_cents

int

 

listed price in cents

currency_code

char

varying(32)

listed currency code

sku

char

varying(32)

listed sku

max_quantity

int

 

listed max_quantity

is_active

bool

 

whether or not the offer is active

 

promo_code

Field name

Format

Length

Description

created_at

datetime

 

timestamp of when the object was created

promo_code_id

char

varying(32)

unique id of the promo code

code

char

varying(40)

value of the promo code

use_count

int

 

number of times the promo code has been used

max_uses

int

 

maximum number of times the promo code can be used

is_active

bool

 

whether or not this promo code is active and can be used

promo_code_pool_id

int

varying(32)

unique id of the promo code pool the promo code belongs to

 

promo_code_pool

Field name

Format

Length

Description

created_at

datetime

 

timestamp of when the object was created

promo_code_pool_id

char

varying(32)

unique id of the promo code pool

name

char

varying(255)

name of the promo code pool

bulk_purchase_id

char

varying(32)

unique id of the purchase - this is only present when the code was a result of a bulk purchase

 

published_course

Field name

Format

Length

Description

created_at

datetime

 

timestamp of when the object was created

published_course_id

char

varying(32)

unique id of the published course

is_live

bool

 

whether or not the published course is live

url

char

varying(255)

the url of the published course

course_id

char

varying(32)

unique id of the course being published

domain_id

char

varying(32)

unique id of the domain the course is published on

 

published_course_tags

Field name

Format

Length

Description

published_course_tag_id

char

varying(32)

unique id of the published course tag

created_at

datetime

 

timestamp of when the object was created

published_course_id

char

varying(32)

unique id of the published course this tag is applied to

tag_id

char

varying(32)

unique id of the tag being applied

 

purchase

Field name

Format

Length

Description

created_at

datetime

 

timestamp of when the object was created

purchased_at

datetime

 

timestamp of when the actual purchase occurred

purchase_id

char

varying(32)

unique id of the purchase

refunded_at

datetime

 

timestamp of when the purchase was refunded

order_id

char

varying(20)

unique id for use in order reports

state

char

varying(10)

status of the purchase (SUCCESS, FAILED, REFUNDED, etc.)

payment_processor

char

varying(10)

name of the payment processor used (Stripe, PayPal, etc.)

payment_processor_account_id

char

varying(512)

unique id of the account in the payment processor's system (Stripe Charge ID, PayPal Payment ID, etc.)

payment_processor_order_id

char

varying(128)

unique id of the payment in the payment processor's system

price_cents

int

 

listed price in cents

price_currency

char

varying(3)

listed currency

quantity

int

 

quantity purchased

promo_code_id

char

varying(32)

unique id of the promo code if one was used

promo_code_price_cents

int

 

listed price in cents (promo code)

promo_code_quantity

int

 

quantity of promo codes used

student_id

char

varying(32)

unique id of the student this purchase belongs to

offer_id

char

varying(32)

unique id of the offer that was purchased

offer_sku

char

varying(32)

listed sku (copied from offer at time of purchase)

offer_price_cents

int

 

listed price in cents (copied from offer at time of purchase)

 

quiz

Field name

Format

Length

Description

created_at

datetime

 

timestamp of when the object was created

quiz_id

char

varying(32)

unique id of the quiz

name

char

varying(100)

name of the quiz

passing_percentage_correct

int

 

the minimum percentage of questions correct needed to pass the quiz

max_attempts

int

 

the maximum number of quiz attempts permitted

 

quiz_answer

Field name

Format

Length

Description

created_at

datetime

 

timestamp of when the object was created

quiz_answer_id

char

varying(32)

unique id of the quiz answer

order

int

 

the order in which this answer appears within the question

is_correct

bool

 

whether or not the answer is considered correct for the question

text

char

varying(1000)

the value of the answer

quiz_question_id

char

varying(32)

unique id of the quiz this question belongs to

 

quiz_question

Field name

Format

Length

Description

created_at

datetime

 

timestamp of when the object was created

quiz_question_id

char

varying(32)

unique id of the quiz question

type

char

varying(20)

the question type (‘MULTIPE_CHOICE’, ‘MULTIPLE_ANSWER’, ‘FILL_IN_THE_BLANK’)

order

int

 

the order in which this question appears within the quiz

html

text

 

the HTML formatted value of the question

quiz_id

char

varying(32)

unique id of the quiz this question belongs to

 

quiz_question_response

Field name

Format

Length

Description

created_at

datetime

 

timestamp of when the object was created

quiz_question_response_id

char

varying(32)

unique id for the quiz question response

is_correct

bool

 

whether or not the response was considered correct for the question (True/False)

submit_count

int

 

number of times the question was attempted within a single quiz attempt

started_at

datetime

 

timestamp of when the question response was started

finished_at

datetime

 

timestamp of when the question response was finished

quiz_answer_id

char

varying(32)

unique id for the student's answer (does not apply for Multiple Answer questions)

quiz_response_id

char

varying(32)

unique id for the quiz response this belongs to

quiz_question_id

char

varying(32)

unique id for the question this is in response to

response_text

char

varying(1000)

the student's provided free-form answer (only applies for Fill in the Blank questions)

 

quiz_question_response_chosen_answers

Field name

Format

Length

Description

created_at

datetime

 

timestamp of when the object was created

quiz_question_response chosen_answer_id

char

varying(32)

unique id of the quiz question response chosen answer

quiz_answer_id

char

varying(32)

unique id of the chosen answer

quiz_question_response_id

char

varying(32)

unique id of the question response this belongs to

 

quiz_response

Field name

Format

Length

Description

created_at

datetime

 

timestamp of when the object was created

quiz_response_id

char

varying(32)

unique id of the quiz response

correct_response_count

char

varying(12)

number of questions the student answered correctly

question_count

int

 

total number of questions in the quiz

is_passed

bool

 

whether or not the student passed the quiz (True/False)

started_at

datetime

 

timestamp of when the student started the quiz

finished_at

datetime

 

timestamp of when the student finished the quiz

quiz_id

char

varying(32)

unique id of the quiz

student_lesson_progress_id

char

varying(32)

unique id of the student lesson progress this belongs to

 

scorm_interaction

Field name

Format

Length

Description

scorm_interaction_id

char

varying(32)

unique id of the SCORM interaction

created_at

datetime

 

timestamp of when the object was created

student_sco_progress_id

char

varying(15)

unique id of the student SCORM progress

identifier

char

varying(255)

unique identifier for the SCORM interaction within its package

type

char

varying(15)

type of the SCORM interaction (‘true-false’, ‘choice’, ‘fill-in’, ‘matching’, ‘performance’, ‘sequencing’, ‘likert’, ‘numeric’, ‘other’)

weighting

char

varying(200)

a factor which is used to identify the relative importance of one interaction compared to another

order

int

 

the order of the SCORM interaction

time

char

varying(20)

a chronological point in a 24-hour clock which identifies when the interaction was completed

response

char

varying(16000)

the actual student response to the SCORM interaction

result

char

varying(15)

how the system judges the described response

 

scorm_resource

Field name

Format

Length

Description

scorm_resource_id

char

varying(32)

unique id of the the SCORM resource

created_at

datetime

 

timestamp of when the object was created

web_package_id

char

varying(32)

unique id of the SCORM web package

identifier

char

varying(2000)

unique identifier for the SCORM resource within its package

type

char

varying(32)

content type (‘sco’, ‘asset’)

 

student

Field name

Format

Length

Description

created_at

datetime

 

timestamp of when the object was created

student_id

char

varying(32)

unique id of the student

first_name

char

varying(30)

first name of the student

last_name

char

varying(30)

last name of the student

email

char

varying(254)

email address of the student

 

student_course_progress

Field name

Format

Length

Description

created_at

datetime

 

timestamp of when the object was created

student_course_progress_id

char

varying(32)

unique id of student course progress

latest_activity_at

datetime

 

timestamp of the student’s most recent activity within the course

completed_at

datetime

 

timestamp of when the student completed the course

score

int

 

score the student received on the course (in cases where course tied to a quiz score)

score_max

int

 

maximum possible score possible for the course

credits_earned

char

varying(20)

credits earned by the student from taking the course

success_status

char

varying(10)

student’s course success status (Passed, Failed)

 

student_group

Field name

Format

Length

Description

created_at

datetime

 

timestamp of when the object was created

student_group_id

char

varying(32)

unique id of the student group

name

char

varying(100)

name of the student group

 

student_group_membership

Field name

Format

Length

Description

created_at

datetime

 

timestamp of when the object was created

student_group_membership_id

char

varying(32)

unique id of the student group membership

student_id

char

varying(32)

unique id of the student

student_group_id

char

varying(32)

unique id of the student group this belongs to

 

student_lesson_progress

Field name

Format

Length

Description

created_at

datetime

 

timestamp of when the object was created

student_lesson_progress_id

char

varying(32)

unique id of the student lesson progress

view_count

int

 

number of times student viewed the lesson

score_max

int

 

maximum possible score achievable for the lesson (if applicable)

success_status

char

varying(32)

student’s lesson success status (Passed, Failed)

lesson_id

char

varying(32)

unique id of the lesson this belongs to

last_viewed_at

datetime

 

timestamp of when the student last viewed the lesson

student_course_progress_id

char

varying(32)

unique id of the student course progress this belongs to

completed_at

datetime

 

timestamp of when the student completed the lesson

score

int

 

score student achieved for the lesson (if applicable)

 

student_sco_progress

Field name

Format

Length

Description

student_sco_progress_id

char

varying(32)

unique id of the SCORM progress

created_at

datetime

 

timestamp of when the object was created

attempted_at

datetime

 

timestamp of when a new SCORM progress was created. It is used to surface user SCO attempts if a SCO lesson is configured to record multiple attempts.

student_lesson_progress _id

char

varying(32)

unique id for the student lesson progress this belongs to

scorm_resource_id

char

varying(32)

unique id for the SCORM resource this belongs to

score_raw

char

varying(200)

the most recent score the student achieved for the SCORM module

score_min

char

varying(200)

the minimum score for the SCORM module

score_max

char

varying(200)

the maximum score for the SCORM module

total_time

int

 

total time spent on the SCORM module

status

char

varying(32)

status as reported by the SCORM module (‘passed’, ‘completed’, ‘failed’, ‘incomplete’, ‘browsed’, ‘not attempted’)

 

tag

Field name

Format

Length

Description

tag_id

char

varying(32)

unique id of the tag

created_at

datetime

 

timestamp of when the object was created

name

char

varying(100)

name of the tag

slug

char

varying(100)

slug of the tag

 

vilt_session

Field name

Format

Length

Description

created_at

datetime

 

timestamp of when the object was created

vilt_session_id

char

varying(32)

unique id of the VILT session

display_name

char

varying(100)

display name of the VILT session

instructor_name

char

varying(100)

name of the instructor affiliated with the VILT session

lesson_id

char

varying(32)

unique id of the lesson this VILT session belongs to

seats_total

int

 

total number of seats available for the VILT session

 

vilt_session_event

Field name

Format

Length

Description

created_at

datetime

 

timestamp of when the object was created

vilt_session_event_id

char

varying(32)

unique id of the VILT session event

starts_at

datetime

 

timestamp of when the event starts / started

ends_at

datetime

 

timestamp of when the event ends / ended

location

char

varying(100)

location of the event

timezone

char

varying(63)

timezone for when the event starts / ends

vilt_session_id

char

varying(32)

unique id for the VILT session this event belongs to

vilt_session_registration

Field name

Format

Length

Description

vilt_session_registration_id

char

varying(32)

unique id of the VILT registration

created_at

datetime

 

timestamp of when the object was created

vilt_session_id

char

varying(32)

unique id of the VILT session this belongs to

student_lesson_progress_id

char

varying(32)

unique id of the student lesson progress this belongs to

attended

bool

 

whether or not the student attended the VILT session (True/False)

 

web_package

Field name

Format

Length

Description

created_at

datetime

 

timestamp of when the object was created

web_package_id

char

varying(32)

unique id of the web package

title

char

varying(500)

title of the web package

type

char

varying(10)

identifies the type of web package (HTML/SCORM)



Have more questions? Submit a request

Comments

Powered by Zendesk