Facts
Dimension
Both
Version 4.2.9
Intro
The following documentation describes the data dictionary for the Canvas Data warehouse. Following typical data warehouse conventions, the database records from canvas are transformed into a fact and dimension tables. Put succinctly, fact tables contain measurements and dimension tables contain the different dimensions that can be used to slice and aggregate the data (see Dimensional Modeling). Canvas Data mostly adheres to a Star schema convention, which means that most of the relations should only be one join away (see Star schema). These tables are either available as a set of flat files or hosted in a Amazon Redshift instance which is optimized for a range of analytical queries. For help with Canvas Data, please try posting on the JIVE forum. For more information on Canvas Data, please contact your CSM.
Notes
- All timestamps in Canvas Data are UTC
assignment_fact
Table contains measures related to assignments.
Type: fact
Columns
Name | Type | Description |
---|---|---|
assignment_id | bigint | Foreign key to assignment dimension |
course_id | bigint | Foreign key to the course associated with this assignment |
course_account_id | bigint | Foreign key to the account associated with the course associated with this assignment |
enrollment_term_id | bigint | Foreign Key to enrollment term table |
points_possible | double precision | Total points possible for the assignment |
peer_review_count | int | The number of pears to assign for review if using algorithmic assignment |
assignment_group_id | bigint | Foreign key to the assignment group dimension table. |
external_tool_id | bigint | Foreign key to the external tool activation if this assignment uses an external tool for submissions. |
assignment_group_fact
Measures for assignment_groups.
Type: fact
Columns
Name | Type | Description |
---|---|---|
assignment_group_id | bigint | Foreign key to the assignment group dimension table. |
course_id | bigint | Foreign key to the course to which the assignment group belongs to. |
group_weight | double precision | Weight of the assignment group. Reflects the value populated in the '% of total grade' field in Canvas while creating the assignment group. |
assignment_group_score_fact
Table containing measures for Assignment Group scores within Canvas gradebook.
Type: fact
Columns
Name | Type | Description |
---|---|---|
score_id | bigint | Unique surrogate identifier for the score. |
canvas_id | bigint | Primary key for the score. |
account_id | bigint | Foreign key to the Account group table. |
course_id | bigint | Foreign key to the Course group table. |
assignment_group_id | bigint | Foreign key to the Assignment group table. |
enrollment_id | bigint | Foreign key to the Enrollment table. |
current_score | double precision | Current score. |
final_score | double precision | Final score. |
muted_current_score | double precision | Current score that might not yet be public, or is muted. |
muted_final_score | double precision | Final score that might not yet be public. Or is muted. |
assignment_override_fact
Table contains measures related to assignment overrides. Overrides can be found in the assignment_override_dim. Overrides are primarily the dates about the assigmnents for a given group of assignees.
Type: fact
Columns
Name | Type | Description |
---|---|---|
assignment_override_id | bigint | Unique surrogate ID for the assignment_override. |
account_id | bigint | Foreign key to the account associated with the course associated with this assignment. |
assignment_id | bigint | Foreign key to the assignment the override is associated with. May be empty. |
assignment_group_id | bigint | Foreign key to the assignment group dimension table. |
course_id | bigint | Foreign key to the course associated with this assignment. |
course_section_id | bigint | Foreign key to the course_section. |
enrollment_term_id | bigint | Foreign Key to enrollment term table. |
group_id | bigint | Foreign key to the group. |
group_category_id | bigint | (Not implemented) Foreign key to group category dimension table. |
group_parent_account_id | bigint | If the group is directly associated with an account, this is the id. |
nonxlist_course_id | bigint | The course ID for the original course if this course has been cross listed. |
quiz_id | bigint | Foreign key to the quiz the override is associated with. May be empty. |
group_wiki_id | bigint | Foreign key to the wiki_dim table. |
assignment_override_user_fact
Table contains measures related to students for whom an assignment override exists.
Type: fact
Columns
Name | Type | Description |
---|---|---|
assignment_override_user_id | bigint | Unique surrogate ID for the assignment_override_student. Is made up by adding a large number to the ID of the source table. |
account_id | bigint | Foreign key to the account associated with the course associated with this assignment. |
assignment_group_id | bigint | Foreign key to the assignment group dimension this fact is related to |
assignment_id | bigint | Foreign key to the assignment the override is associated with. May be empty. |
assignment_override_id | bigint | Foreign key to the assignment override dimension this fact is related to |
course_id | bigint | Foreign key to the course associated with this assignment. |
enrollment_term_id | bigint | Foreign Key to enrollment term table. |
quiz_id | bigint | Foreign key to the quiz the override is associated with. May be empty. |
user_id | bigint | Foreign key to the user. |
assignment_override_user_rollup_fact
Table contains measures related to students for whom an assignment override exists. This table contains the user ids of users for whom an override was created. There are 3 ways a user can be included, via an adhoc form, via a group membership, or a course section. All three are included here.
Type: fact
Columns
Name | Type | Description |
---|---|---|
assignment_id | bigint | Foreign key to the assignment the override is associated with. May be empty. |
assignment_override_id | bigint | The ID of the assignment_override for this override user. |
assignment_override_user_adhoc_id | bigint | When not empty, this field is the ID of the user in the adhoc group table. |
assignment_group_id | bigint | Foreign key to the assignment group dimension table. |
course_id | bigint | Foreign key to the course associated with this assignment. |
course_account_id | bigint | Foreign key to the account associated with the course associated with this assignment. |
course_section_id | bigint | When not empty, this field is the ID of the course_section the user is part of. |
enrollment_id | bigint | When not empty, this field is the ID of the enrollment for a course section. |
enrollment_term_id | bigint | Foreign Key to enrollment term table. |
group_category_id | bigint | When not empty, this field is the ID of the group category the user is part of. |
group_id | bigint | When not empty, this field is the ID of the group the user is part of. |
group_parent_account_id | bigint | If the group is directly associated with an account, this is the id. |
group_wiki_id | bigint | Foreign key to the wiki_dim table. |
nonxlist_course_id | bigint | The course ID for the original course if this course has been cross listed. |
quiz_id | bigint | Foreign key to the quiz the override is associated with. May be empty. |
user_id | bigint | Foreign key to the user. |
catalog_order_fact
Measures for catalog orders
Type: fact
Columns
Name | Type | Description |
---|---|---|
catalog_order_id | bigint | Foreign key to the catalog order dim |
catalog_id | bigint | Foreign key to the catalog dim |
parent_catalog_id | bigint | Foreign key to the catalog dim. References the parent of the catalog that this order belongs to |
user_id | bigint | Foreign key to the user dim. Refers to the user associated with this order |
total | double precision | Cost of the catalog order. Units are found in catalog_order_dim.currency |
catalog_order_item_fact
Measures for catalog order items
Type: fact
Columns
Name | Type | Description |
---|---|---|
catalog_order_item_id | bigint | Foreign key to the catalog order item dim |
catalog_id | bigint | Foreign key to the catalog dim. Refers to the catalog this order item belongs to |
parent_catalog_id | bigint | Foreign key to the catalog dim. References the parent of the catalog that this order item belongs to |
catalog_order_id | bigint | Foreign key to the catalog order dim |
catalog_product_id | bigint | Foreign key to the catalog product dim. Refers to the course or program associated with this order item |
catalog_promotion_id | bigint | Foreign key to the catalog promotion dim |
amount | double precision | Cost of the catalog order. Units are found in catalog_order_dim.currency |
catalog_payment_fact
Measures for catalog payments
Type: fact
Columns
Name | Type | Description |
---|---|---|
catalog_payment_id | bigint | Foreign key to the catalog payment dim |
catalog_id | bigint | Foreign key to the catalog dim. Refers to the catalog this payment belongs to |
parent_catalog_id | bigint | Foreign key to the catalog dim. References the parent of the catalog this payment belongs to |
catalog_order_id | bigint | Foreign key to the catalog order dim |
amount | double precision | The payment amount |
catalog_product_fact
Facts for products in Canvas Catalog. A product can be either a course or a program listing
Type: fact
Columns
Name | Type | Description |
---|---|---|
catalog_product_id | bigint | Foreign key to the catalog product dim |
catalog_id | bigint | Foreign key to the catalog dim |
parent_catalog_id | bigint | Foreign key to the catalog dim. References the parent of the catalog that this product belongs to |
course_id | bigint | Foreign key to the course dim if this product is a course |
enrollment_term_id | bigint | Foreign key to the enrollment term dim |
enrollment_fee | double precision | Cost of the catalog product. Units are found in catalog_dim.currency |
credits | double precision | Number of credits the course is worth if the product is a course |
waitlist_capacity | int | The maximum capacity of the waitlist. Null if the waitlist has no maximum capacity |
enrollment_capacity | int | The maximum enrollment capacity for the course or program |
catalog_program_requirement_fact
Facts for the courses or programs required for completion of a program
Type: fact
Columns
Name | Type | Description |
---|---|---|
id | bigint | Unique surrogate key for the program requirement |
catalog_id | bigint | Foreign key to the catalog dim. Refers to the catalog in which this requirement is defined |
catalog_program_id | bigint | Foreign key to the catalog product dim. This ID refers to the program that requires the program or course referred to by "catalog_product_id" |
catalog_product_id | bigint | Foreign key to the catalog product dim. This ID refers to the program or course required by the program referred to by "catalog_program_id" |
course_id | bigint | Foreign key to the course dim. Refers to the required course if the requirement refers to a course |
catalog_promotion_fact
Measures for catalog promotions
Type: fact
Columns
Name | Type | Description |
---|---|---|
catalog_promotion_id | bigint | Foreign key to the catalog promotion dim |
catalog_id | bigint | Foreign key to the catalog dim. Refers to the catalog this promotion belongs to |
parent_catalog_id | bigint | Foreign key to the catalog dim. References the parent of the catalog this promotion belongs to |
catalog_product_id | bigint | Foreign key to the associated course or program from the catalog product dim. If null, this promotion is available for all courses or programs in the catalog |
amount | double precision | The amount of the promotion. If discount_type is "flat", this represents an amount in currency. If discount_type is "percent", this represents a percentage |
communication_channel_fact
Measures for communication channel.
Type: fact
Columns
Name | Type | Description |
---|---|---|
communication_channel_id | bigint | Foreign key to the communication channel dimension table. |
user_id | bigint | Foreign key to the user that owns this communication channel. |
bounce_count | integer | Number of permanent bounces since the channel was last reset. If it's greater than 0, then no email is sent to the channel, until it is either reset by a siteadmin or it is removed and re-added by a user. |
conference_fact
Measures for conferences
Type: fact
Columns
Name | Type | Description |
---|---|---|
conference_id | bigint | Foreign key to the conference dimension table |
group_id | bigint | Foreign key to the group if this conference was associated with a group |
course_id | bigint | Foreign key to the course if this conference was associated with a course |
account_id | bigint | Foreign key to the account if this conference was associated with an account |
duration | double precision |
conference_participant_fact
Measures for conference participants
Type: fact
Columns
Name | Type | Description |
---|---|---|
conference_participant_id | bigint | Foreign key to the conference participant |
group_id | bigint | Foreign key to the group if this conference was associated with a group |
course_id | bigint | Foreign key to the course if this conference was associated with a course |
account_id | bigint | Foreign key to the account if this conference was associated with an account |
user_id | bigint | Foreign key to the user who is the conference participant |
conference_id | bigint | Foreign key to the conference |
conversation_message_participant_fact
Fact table for each message in a conversation and each participant
Type: fact
Columns
Name | Type | Description |
---|---|---|
conversation_message_id | bigint | Foreign key to the message dimension for the associated message. |
conversation_id | bigint | Foreign key to the conversation dimension for the associated conversation |
user_id | bigint | Foreign key to the user dimension for the associated user |
course_id | bigint | Foreign key to the course dimension for the associated course. |
enrollment_term_id | bigint | Foreign Key to enrollment term table |
course_account_id | bigint | Foreign Key to the course's account |
group_id | bigint | Foreign key to the group dimension for a particular group |
account_id | bigint | Foreign key to account_dim |
enrollment_rollup_id | bigint | Foreign key to the enrollment roll-up dimension table |
message_size_bytes | int | The message size in bytes. |
message_character_count | int | The message size in characters. |
message_word_count | int | The message size in words using space and common punctuation as word breaks. |
message_line_count | int | The number of lines in a message. |
course_score_fact
Table containing measures for overall course scores within Canvas gradebook.
Type: fact
Columns
Name | Type | Description |
---|---|---|
score_id | bigint | Unique surrogate identifier for the score. |
canvas_id | bigint | Primary key for the score. |
account_id | bigint | Foreign key to the Account group table. |
course_id | bigint | Foreign key to the Course group table. |
enrollment_id | bigint | Foreign key to the Enrollment table. |
current_score | double precision | Current score. |
final_score | double precision | Final score. |
muted_current_score | double precision | Current score that might not yet be public, or is muted. |
muted_final_score | double precision | Final score that might not yet be public. Or is muted. |
course_ui_navigation_item_fact
Facts describing a single item in the navigation UI
Type: fact
Columns
Name | Type | Description |
---|---|---|
root_account_id | bigint | Foreign key to root account of the course |
course_ui_navigation_item_id | bigint | Foreign key to course_ui_navigation_item_dim |
course_ui_canvas_navigation_id | bigint | Foreign key to navigation function |
external_tool_activation_id | bigint | Foreign key to external_tool_activation_dim |
course_id | bigint | Foreign key to course |
course_account_id | bigint | Foreign key to account for course |
enrollment_term_id | bigint | Foreign key to enrollment term |
discussion_entry_fact
Measures for discussion entries. Discussion entries are replies in a discussion topic.
Type: fact
Columns
Name | Type | Description |
---|---|---|
discussion_entry_id | bigint | Foreign key to this entries attributes. |
parent_discussion_entry_id | bigint | Foreign key to the reply that it is nested underneath. |
user_id | bigint | Foreign key to the user that created this entry. |
topic_id | bigint | Foreign key to associated discussion topic. |
course_id | bigint | Foreign key to associated course. |
enrollment_term_id | bigint | Foreign Key to enrollment term table |
course_account_id | bigint | Foreign key to account for associated course. |
topic_user_id | bigint | Foreign key to user that posted the associated discussion topic. |
topic_assignment_id | bigint | Foreign key to assignment associated with the entry's discussion topic. |
topic_editor_id | bigint | Foreign key to editor associated with the entry's discussion topic. |
enrollment_rollup_id | bigint | Foreign key to the enrollment roll-up dimension table |
message_length | int | Length of the message in bytes |
discussion_topic_fact
Measures for discussion topics/threads.
Type: fact
Columns
Name | Type | Description |
---|---|---|
discussion_topic_id | bigint | Foreign key to the discussion topic dimension for the associated discussion topic. |
course_id | bigint | Foreign key to the course dimension |
enrollment_term_id | bigint | Foreign Key to enrollment term table |
course_account_id | bigint | (currently un-populated) Foreign key to the account dimension for the account associated with the associated course |
user_id | bigint | Foreign key to the user dimension for the user that created the discussion topic. |
assignment_id | bigint | Foreign key to the assignment dimension |
editor_id | bigint | Foreign key to the user to last edit the entry, if different than user_id |
enrollment_rollup_id | bigint | Foreign key to the enrollment roll-up dimension table |
message_length | int | Best guess at the count of characters in the message. Special characters are treated differently in different systems. As a result, you may find variance in message length in your own systems. NULL messages are mapped to 0 length. |
group_id | bigint | Foreign key to the group dimension |
group_parent_course_id | bigint | Foreign key to course dimension. |
group_parent_account_id | bigint | Foreign key to accounts table. |
group_parent_course_account_id | bigint | Foreign key to the account dimension for the account associated with the course to which the group belongs to. |
enrollment_fact
Measures for enrollments
Type: fact
Columns
Name | Type | Description |
---|---|---|
enrollment_id | bigint | Foreign key for the attributes of the enrollment |
user_id | bigint | Foreign key to the enrolled user |
course_id | bigint | Foreign key to the enrolled course |
enrollment_term_id | bigint | Foreign key to the enrollment term table |
course_account_id | bigint | Foreign key to the account of the enrolled course |
course_section_id | bigint | Foreign key to the enrolled section |
computed_final_score | double precision | [Deprecated] No longer used in Canvas, will always be NULL. |
computed_current_score | double precision | [Deprecated] No longer used in Canvas, will always be NULL. |
external_tool_activation_fact
Facts and denormalized dimensions for external tool (LTI) activations.
Type: fact
Columns
Name | Type | Description |
---|---|---|
external_tool_activation_id | bigint | Foreign key to the external_tool_activation_dim dimension with attribute for this activation |
course_id | bigint | Foreign key to the course if this tool was activated in a course |
account_id | bigint | Foreign key to the account this tool was activated in if it was activated in an account |
root_account_id | bigint | Foreign key to the root account for this data |
enrollment_term_id | bigint | Foreign key to the course's enrollment term if this tool was activated in a course |
course_account_id | bigint | Foreign key to the course's account if this tool was activated in a course |
file_fact
Measures for files.
Type: fact
Columns
Name | Type | Description |
---|---|---|
file_id | bigint | Foreign key to this file dimesion table. |
account_id | bigint | Foreign key to the account this file belongs to. |
assignment_id | bigint | Foreign key to the assignment, the quiz/quiz submission/submission associated with this file belongs to. |
assignment_group_id | bigint | Foreign key to the assignment group, the assignment/submission associated with this file belongs to. |
conversation_id | bigint | Foreign key to the conversation, the conversation message associated with this file belongs to. |
conversation_message_author_id | bigint | Foreign key to the user, who authored the conversation message this file belongs to. |
conversation_message_id | bigint | Foreign key to the conversation message this file belongs to. |
course_id | bigint | Foreign key to the course, the assignment/quiz/quiz submission/submission associated with this file belongs to. |
enrollment_rollup_id | bigint | Foreign key to the enrollment roll-up, the quiz submission/submission associated with this file belongs to. |
enrollment_term_id | bigint | Foreign Key to enrollment term, the assignment/conversation message/group/quiz/quiz submission/submission associated with this file belongs to. |
folder_id | bigint | Foreign key to the folder this file belongs to. |
grader_id | bigint | Foreign key to the user who graded the submission associated with this file. Please see submission_id for clarification on the relationship between a file and a submission. |
group_id | bigint | Foreign key to the group this file belongs to. |
group_category_id | bigint | (Not implemented) Foreign key to group category the group associated with this file belongs to. |
quiz_id | bigint | Foreign key to the quiz, the quiz/quiz submission associated with this file belongs to. |
quiz_submission_id | bigint | Foreign key to the quiz submission this file belongs to. |
replacement_file_id | bigint | Foreign key to the file which overwrote/replaced this file. Defaults to 'NULL' when the file was not overwritten/replaced. |
root_file_id | bigint | Foreign key to the source file from which this file was copied and created. Defaults to 'NULL' when this is the only copy. |
sis_source_id | varchar | Correlated ID for the record for the course, associated with this file, in the SIS system (assuming SIS integration is configured). |
submission_id | bigint | Foreign key to the submission this file belongs to if the file's context was a submission or quiz submission. A file's context is an independent attribute from its relationship with a submission. Files have a many-to-many relationship with submissions in Canvas which requires a junction table to represent. See submission_file_fact for details on the junction table that links files to submissions. |
uploader_id | bigint | Foreign key to the user who uploaded this file. Might contain users which are not in the user dimension table. |
user_id | bigint | Foreign key to the user this file belongs to. |
wiki_id | bigint | Foreign key to the wiki the conversation message/group/submission associated with this file belongs to. |
size | bigint | Size of this file in bytes. |
grading_period_fact
Measures for grading periods.
Type: fact
Columns
Name | Type | Description |
---|---|---|
grading_period_id | bigint | Unique surrogate identifier for the grading period. |
canvas_id | bigint | Primary key for the grading period. |
grading_period_group_id | bigint | Foreign key to the grading period group table. |
grading_period_group_account_id | bigint | One hop ID to the Account table for the grading period group |
grading_period_group_course_id | bigint | One hop ID to the Course table for the grading period group |
weight | double precision | A weight value that contributes to the overall weight of a grading period set which is used to calculate how much assignments in this period contribute to the total grade. |
grading_period_score_fact
Table containing measures for Grading Period scores within Canvas gradebook.
Type: fact
Columns
Name | Type | Description |
---|---|---|
score_id | bigint | Unique surrogate identifier for the score. |
canvas_id | bigint | Primary key for the score. |
account_id | bigint | Foreign key to the Account group table. |
course_id | bigint | Foreign key to the Course group table. |
enrollment_id | bigint | Foreign key to the Enrollment table. |
grading_period_id | bigint | Foreign key to the grading period group table. |
grading_period_group_id | bigint | Foreign key to the grading period group table. |
grading_period_group_account_id | bigint | One hop ID to the Account table for the grading period group table. |
current_score | double precision | Current score. |
final_score | double precision | Final score. |
muted_current_score | double precision | Current score that might not yet be public, or is muted. |
muted_final_score | double precision | Final score that might not yet be public. Or is muted. |
group_fact
Measures for groups.
Type: fact
Columns
Name | Type | Description |
---|---|---|
group_id | bigint | Foreign key to the group dimension for a particular group. |
parent_course_id | bigint | Foreign key to course dimension. |
parent_account_id | bigint | Foreign key to accounts table. |
parent_course_account_id | bigint | Foreign key to the account dimension for the account associated with the course to which the group belongs to. |
enrollment_term_id | bigint | Foreign key to the enrollment term table for the parent course. |
max_membership | int | Maximum number of users that can be accommodated in a group. |
storage_quota | bigint | Storage Limit allowed per group. |
group_category_id | bigint | (Not implemented) Foreign key to group category dimension table. |
account_id | bigint | Parent account for this group. |
wiki_id | bigint | Foreign key to the wiki_dim table. |
group_membership_fact
Measures for groups.
Type: fact
Columns
Name | Type | Description |
---|---|---|
group_id | bigint | Foreign key to the group dimension for a particular group. |
parent_course_id | bigint | Foreign key to course dimension. |
parent_account_id | bigint | Foreign key to accounts table. |
parent_course_account_id | bigint | Foreign key to the account dimension for the account associated with the course to which the group belongs to. |
enrollment_term_id | bigint | Foreign key to the enrollment term table for the parent course. |
user_id | bigint | Foreign key to the user dimension for the users in the group. |
group_membership_id | varchar | The ID of the membership object |
learning_outcome_fact
Learning outcomes are measurable statements that express student knowledge or a student skill. This table contains measures for learning outcomes.
Type: fact
Columns
Name | Type | Description |
---|---|---|
learning_outcome_id | bigint | Foreign key to the learning outcome dimension |
account_id | bigint | Foreign key to the account associated with this outcome, if this outcome was created at the account level. |
course_id | bigint | Foreign key to the course associated with this outcome, if this outcome was created at the course level. |
enrollment_term_id | bigint | Foreign key to the enrollment term of the course associated with this outcome, if this outcome was created at the course level. |
mastery_points | double precision | Minimum number of points required in order for the student to have acheived mastery |
points_possible | double precision | Maximum number of points acheivable for this outcome |
outcome_import_id | bigint | Foreign key to the outcome import associated with this outcome, if this outcome was imported. |
learning_outcome_group_association_fact
A association table to represent the many to many relationship between learning outcomes and learning outcome groups
Type: fact
Columns
Name | Type | Description |
---|---|---|
learning_outcome_id | bigint | Foreign key to the learning outcome dimension |
learning_outcome_group_id | bigint | Foreign key to the learning outcome group dimension |
account_id | bigint | Foreign key to the account associated with this outcome group, if this outcome group was created at the account level. |
course_id | bigint | Foreign key to the course associated with this outcome group, if this outcome group was created at the course level. |
enrollment_term_id | bigint | Foreign key to the enrollment term of the course associated with this outcome group, if this outcome group was created at the course level. |
learning_outcome_group_fact
Learning outcome groups organize outcomes hierarchically within a context, such as an account, course or the global context. This table contains measures for learning outcome groups.
Type: fact
Columns
Name | Type | Description |
---|---|---|
learning_outcome_group_id | bigint | Foreign key to the learning outcome group dimension. |
account_id | bigint | Foreign key to the account associated with this outcome group, if this outcome group was created at the account level. |
course_id | bigint | Foreign key to the course associated with this outcome group, if this outcome group was created at the course level. |
enrollment_term_id | bigint | Foreign key to the enrollment term of the course associated with this outcome group, if this outcome group was created at the course level. |
parent_group_id | bigint | ID associated with the parent of this group. Refers to a learning_outcome_group record. |
root_group_id | bigint | ID associated with the root group in the group hierarchy. Refers to a learning_outcome_group record. |
outcome_import_id | bigint | Foreign key to the outcome import associated with this outcome group, if this group was imported. |
learning_outcome_question_result_fact
Facts for the results of answered questions which have been associated with a learning outcome
Type: fact
Columns
Name | Type | Description |
---|---|---|
learning_outcome_question_result_id | bigint | Foreign key to the learning oucome question result |
learning_outcome_result_id | bigint | Foreign key to the learning outcome result |
learning_outcome_id | bigint | Foreign key to the learning outcome this record is associated with |
assessment_question_id | bigint | Foreign key to the assessment question this record is associated with (assessment_questions to be included in a future release) |
user_id | bigint | Foreign key to the user dim. Refers to the user associated with this result. |
account_id | bigint | Foreign key to the account associated with the outcome which this result belongs to, if the outcome was created at the account level. |
course_id | bigint | Foreign key to the course associated with the outcome which this result belongs to, if the outcome was created at the course level. |
enrollment_term_id | bigint | Foreign key to the enrollment term of the course associated with the outcome which this result belongs to, if the outcome was created at the course level. |
assignment_id | bigint | Foreign key to the assignment associated with the outcome result, if the result was associated with an assignment |
quiz_id | bigint | Foreign key to the quiz associated with the outcome result, if the result was associated with a quiz |
mastery | boolean | Boolean indicating whether user achieved mastery for this question |
score | double precision | The student's score on the question |
attempts | int | The total number of attempts, or submissions. |
possible | double precision | Total number of points possible. |
original_score | double precision | Score on the first attempt. |
original_possible | double precision | Possible points on the first attempt. |
original_mastery | boolean | Boolean indicating whether user achieved mastery. |
percent | double precision | Score's percent of maximum points possible for an outcome, scaled to reflect any custom mastery levels that differ from the learning outcome. |
learning_outcome_result_fact
Learning outcome results are a student's mastery score on a given outcome. This table contains measures for learning outcome results.
Type: fact
Columns
Name | Type | Description |
---|---|---|
learning_outcome_result_id | bigint | Foreign key to the learning outcome result dimension |
account_id | bigint | Foreign key to the account associated with this outcome result, if this outcome result was created at the account level. |
course_id | bigint | Foreign key to the course associated with this outcome result, if this outcome result was created at the course level. |
enrollment_term_id | bigint | Foreign key to the enrollment term of the course associated with this outcome group, if this outcome group was created at the course level. |
assignment_id | bigint | Foreign key to the assignment associated with this outcome result, if this result was associated with an assignment |
quiz_id | bigint | Foreign key to the quiz associated with this outcome result, if this result was associated with a quiz |
learning_outcome_id | bigint | Foreign key to the learning outcome this result is associated with. |
user_id | bigint | ID of the student who made the submission. Foreign key to the user dimension table |
mastery | boolean | Boolean indicating whether user achieved mastery |
score | double precision | The student's score. |
attempts | int | The total number of attempts, or submissions. |
possible | double precision | Total number of points possible. |
original_score | double precision | Score on the first attempt. |
original_possible | double precision | Possible points on the first attempt. |
original_mastery | boolean | Boolean indicating whether user achieved mastery. |
percent | double precision | Percent of maximum points possible for an outcome, scaled to reflect any custom mastery levels that differ from the learning outcome. |
learning_outcome_rubric_criterion_fact
Contains measures for the criterion of a given outcome.
Type: fact
Columns
Name | Type | Description |
---|---|---|
learning_outcome_rubric_criterion_id | bigint | Foreign key to the learning outcome rubric criterion dimension |
learning_outcome_id | bigint | Foreign key to the learning outcome dimension |
account_id | bigint | Foreign key to the account associated with the criterion's outcome, if this outcome was created at the account level. |
course_id | bigint | Foreign key to the course associated with the criterion's outcome, if this outcome was created at the course level. |
enrollment_term_id | bigint | Foreign key to the enrollment term of the course associated with this outcome, if this outcome was created at the course level. |
points | double precision | Points associated with the rubric criterion |
module_completion_requirement_fact
Table containing measures related to module completion requirements.
Type: fact
Columns
Name | Type | Description |
---|---|---|
module_completion_requirement_id | bigint | Unique surrogate ID for the module completion requirement. |
account_id | bigint | Foreign key to the account the module and the module item belong to. |
assignment_id | bigint | Assignment associated with the module item. |
assignment_group_id | bigint | Assignment group associated with the module item. |
course_id | bigint | Foreign key to the course associated with this module and the module item. |
discussion_topic_id | bigint | Discussion topic associated with the module item. |
discussion_topic_editor_id | bigint | Editor of the discussion topic associated with the module item. |
enrollment_rollup_id | bigint | Enrollment rollup associated with the module item. |
enrollment_term_id | bigint | Foreign key to the enrollment term associated with this module and the module item. |
file_id | bigint | File associated with the module item. |
module_id | bigint | Module that contains the completion requirement. |
module_item_id | bigint | Item that is the subject of the completion requirement. |
quiz_id | bigint | Quiz associated with the module item. |
user_id | bigint | User associated with the module item. |
wiki_id | bigint | Foreign key to the wiki associated with this module and the module item. |
wiki_page_id | bigint | Wiki page associated with the module_item. |
min_score | double precision | For min_score type requirements, the score that must be attained for completion. |
module_fact
Table containing measures related to modules.
Type: fact
Columns
Name | Type | Description |
---|---|---|
module_id | bigint | Foreign key to assignment dimension. |
account_id | bigint | Foreign key to the account the module belongs to. |
course_id | bigint | Foreign key to the course associated with this assignment. |
enrollment_term_id | bigint | Foreign key to the enrollment_term associated with the module_fact course. |
wiki_id | bigint | Foreign key to the wiki associated with the module_fact course. |
module_item_fact
Table containing measures related to modules_items.
Type: fact
Columns
Name | Type | Description |
---|---|---|
module_item_id | bigint | Unique surrogate ID for the module_item. |
account_id | bigint | Foreign key to the account the module belongs to. |
assignment_id | bigint | Key into assignments table for 'Assignment', 'DiscussionTopic', 'File', 'Quiz' type items. |
assignment_group_id | bigint | Key into assignment_groups for 'Assignment', 'File' type items. |
course_id | bigint | The course that owns this module. |
discussion_topic_id | bigint | Key into discussion_topics table for 'DiscussionTopic' type items. |
discussion_topic_editor_id | bigint | Key into users table for user who edited 'DiscussionTopic' type items. |
enrollment_rollup_id | bigint | Key into enrollment_rollup table for user associated with 'DiscussionTopic', 'File' type items. |
enrollment_term_id | bigint | Foreign key to the enrollment_term associated with the module course. |
file_id | bigint | Key into file table for 'File' type items. |
module_id | bigint | Parent module for this module item. |
quiz_id | bigint | Key into quizzes table for 'File', 'Quiz' type items. |
user_id | bigint | Key into users table for 'DiscussionTopic', 'File', 'WikiPage' type items. |
wiki_id | bigint | Key into wiki table for 'WikiPage' type items. |
wiki_page_id | bigint | Key into wiki_pages table for 'WikiPage' type items. |
module_prerequisite_fact
Table containing measures related to module prerequisites.
Type: fact
Columns
Name | Type | Description |
---|---|---|
module_prerequisite_id | bigint | Unique surrogate ID for the module prerequisite. |
account_id | bigint | Foreign key to the account the module belongs to. |
course_id | bigint | Foreign key to the course associated with this assignment. |
enrollment_term_id | bigint | Foreign key to the enrollment_term associated with the module_fact course. |
module_id | bigint | Module that contains the prerequisite. |
prerequisite_module_id | bigint | Module that must be completed to fulfill the prerequisite. |
prerequisite_wiki_id | bigint | Foreign key to the wiki associated with the module_fact course. |
wiki_id | bigint | Foreign key to the wiki associated with the module_fact course. |
module_progression_completion_requirement_fact
Table containing measures related to module progression completion requirements.
Type: fact
Columns
Name | Type | Description |
---|---|---|
module_progression_completion_requirement_id | bigint | Unique surrogate ID for the module progression completion requirement. |
account_id | bigint | Key to the account associated with the module progression and the module item. |
assignment_id | bigint | Key to the assignment associated with the module item. |
assignment_group_id | bigint | Key to the assignment group associated with the module item. |
course_id | bigint | Key to the course associated with the module progression and the module item. |
discussion_topic_id | bigint | Key to the discussion topic associated with the module item. |
discussion_topic_editor_id | bigint | Key to the user editing the discussion topic associated with the module item. |
enrollment_rollup_id | bigint | Key to the enrollment rollup associated with the module item. |
enrollment_term_id | bigint | Key to the enrollment term associated with the module progression and the module item. |
file_id | bigint | Key to the file associated with the module item. |
module_id | bigint | Parent module for this module progression and module item. |
module_item_id | bigint | Item that the user has not completed. |
module_progression_id | bigint | Module progression referenced by the completion requirement. |
quiz_id | bigint | Key to the quiz associated with the module item. |
user_id | bigint | Key to the user associated with the module progression and the module item. |
wiki_id | bigint | Key to the wiki associated with the module progression and the module item. |
wiki_page_id | bigint | Key to the wiki page associated with the module item. |
min_score | double precision | For min_score type requirements, the score that must be attained for completion. |
score | double precision | For min_score type requirements, the score that the user has currently achieved. |
module_progression_fact
Table containing measures related to modules_progression.
Type: fact
Columns
Name | Type | Description |
---|---|---|
module_progression_id | bigint | Unique surrogate ID for the module progression. |
account_id | bigint | Foreign key to the account the module belongs to. |
course_id | bigint | Foreign key to the course associated with this module. |
enrollment_term_id | bigint | Foreign key to the enrollment_term associated with the module course. |
module_id | bigint | Parent module for this module progression. |
user_id | bigint | User being tracked in the module progression. |
wiki_id | bigint | Foreign key to the wiki associated with the module course. |
pseudonym_fact
Type: fact
Columns
Name | Type | Description |
---|---|---|
pseudonym_id | bigint | Foreign key to pseudonym dimension table |
user_id | bigint | Foreign key to user associated with this pseudonym |
account_id | bigint | Foreign key to account associated with this pseudonym |
login_count | int | Number of times a user has logged in with this pseudonym |
failed_login_count | int | Number of times failed login attempt to this pseudonym |
quiz_fact
Measures for quiz.
Type: fact
Columns
Name | Type | Description |
---|---|---|
quiz_id | bigint | Foreign key to quiz dimension table. |
points_possible | double precision | Total point value given to the quiz. |
time_limit | int | Time limit, in minutes, to complete the quiz. Set to -1 for no time limit. Defaults to -1. |
allowed_attempts | int | Number of attempts allowed to complete the quiz. Set to -1 for unlimited attempts. Defaults to -1. |
unpublished_question_count | int | Number of questions in the current unpublished version of the quiz. |
question_count | int | Number of questions in the last published version of the quiz |
course_id | bigint | Foreign key to the course the quiz belongs to. |
assignment_id | bigint | Foreign key to the assignment the quiz belongs to. |
course_account_id | bigint | Foreign key to the account associated with the course associated with this quiz. |
enrollment_term_id | bigint | Foreign key to enrollment term the quiz belongs to. |
quiz_question_answer_fact
Measures for answers related to a quiz question.
Type: fact
Columns
Name | Type | Description |
---|---|---|
quiz_question_answer_id | bigint | Foreign key to the quiz question answer dimension table. As with all surrogate keys in Canvas Data, there is no guarantee of stability. That said, this key is particularly unstable and will likely change from dump to dump even if there are no data change. |
quiz_question_id | bigint | Foreign key to the quiz question dimension table. |
quiz_question_group_id | bigint | Foreign key to the quiz group dimension table. |
quiz_id | bigint | Foreign key to the quiz dimension table. |
assessment_question_id | bigint | Foreign key to the assessment question dimension table (to be made available in later releases). |
course_id | bigint | Foreign key to the course this group's quiz belongs to. |
assignment_id | bigint | Foreign key to the assignment the quiz belongs to. |
course_account_id | bigint | Foreign key to the account of the course this group belongs to. |
enrollment_term_id | bigint | Foreign key to the enrollment term of the course this group belongs to. |
weight | double precision | Integer value to determine correctness of the answer. Incorrect answers should be 0, correct answers should be non-negative. |
exact | double precision | (Used in 'numerical_question' with answer type 'exact_answer', set to 'NULL' otherwise) Value the answer must be equal to. |
margin | double precision | (Used in 'numerical_question' with answer type 'exact_answer', set to 'NULL' otherwise) Margin of error allowed for a student's answer. |
starting_range | double precision | (Used in 'numerical_question' with answer type 'range_answer', set to 'NULL' otherwise) Start of the allowed range (inclusive). |
ending_range | double precision | (Used in 'numerical_question' with answer type 'range_answer', set to 'NULL' otherwise) End of the allowed range (inclusive). |
quiz_question_fact
Measures of a question associated with a quiz.
Type: fact
Columns
Name | Type | Description |
---|---|---|
quiz_question_id | bigint | Foreign key to the quiz question dimension table. |
quiz_id | bigint | Foreign key to the quiz dimension table. |
quiz_question_group_id | bigint | Foreign key to the quiz group dimension table. |
assessment_question_id | bigint | Foreign key to the assessment question dimension table (to be made available in later releases). |
course_id | bigint | Foreign key to the course this group's quiz belongs to. |
assignment_id | bigint | Foreign key to the assignment the quiz belongs to. |
course_account_id | bigint | Foreign key to the account of the course this group belongs to. |
enrollment_term_id | bigint | Foreign key to the enrollment term of the course this group belongs to. |
points_possible | double precision | Maximum number of points that can be awarded for answering the question correctly. |
quiz_question_group_fact
Measures related to quiz groups.
Type: fact
Columns
Name | Type | Description |
---|---|---|
quiz_question_group_id | bigint | Foreign key to quiz group. |
pick_count | int | Number of questions picked from the group for the quiz the group is associated with. |
question_points | double precision | Number of points to assign per question in the group. |
quiz_id | bigint | Foreign key to quiz dimension. |
course_id | bigint | Foreign key to the course this group's quiz belongs to. |
assignment_id | bigint | Foreign key to the assignment the quiz belongs to. |
course_account_id | bigint | Foreign key to the account of the course this group belongs to. |
enrollment_term_id | bigint | Foreign key to the enrollment term of the course this group belongs to. |
quiz_submission_fact
Measures for the last submitted quiz
Type: fact
Columns
Name | Type | Description |
---|---|---|
score | double precision | Denotes the score for this submission. Its value would be NULL when they are in the 'preview', 'untaken' OR 'settings_only' workflow states (since it is associated with quiz moderation events). Or its value should not be NULL when workflow state is either 'complete' or 'pending_review'. It defaults to NULL. |
kept_score | double precision | For quizzes that allow multiple attempts, this is the actual score that will be associated with the user for this quiz. This score depends on the scoring policy we have for the submission in the quiz submission dimension table, the workflow state being 'completed' or 'pending_review' and the allowed attempts to be greater than 1. Its value can be NULL when not all these required conditions are met. |
date | timestamp | Contains the same value as 'finished_at'. Provided to support backward compatibility with the existing table in production. |
course_id | bigint | Foreign key to the course this submission belongs to. |
enrollment_term_id | bigint | Foreign key to the enrollment term of the course this submission belongs to. |
course_account_id | bigint | Foreign key to the account of the course this submission belongs to. |
quiz_id | bigint | ID of the quiz the quiz submission represents. Foreign key to the quiz dimension table. |
assignment_id | bigint | Foreign key to the assignment the quiz belongs to. |
user_id | bigint | ID of the user (who is a student) who made the submission. Foreign key to the user dimension table. |
submission_id | bigint | ID to the submission the quiz submission represents. Foreign key to the quiz submission dimension table. |
enrollment_rollup_id | bigint | Foreign key to the enrollment roll-up dimension table. |
quiz_submission_id | bigint | Foreign key to the quiz submission dimension table. |
quiz_points_possible | double precision | Maximum points that can be scored in this quiz. |
score_before_regrade | double precision | Original score of the quiz submission prior to any re-grading. It's NULL if the submission has never been regraded. Defaults to NULL. |
fudge_points | double precision | Number of points the quiz submission's score was fudged (changed) by. Values can be negative or positive. Defaults to 0. |
total_attempts | int | Denotes the total number of attempts made by the student for the quiz. Is valid only if the quiz allows multiple attempts. |
extra_attempts | int | Number of times the student was allowed to re-take the quiz over the multiple-attempt limit. |
extra_time | int | Amount of extra time allowed for the quiz submission, in minutes. |
time_taken | int | Time taken, in seconds, to finish the quiz. |
quiz_submission_historical_fact
Measures for the all submitted quizzes
Type: fact
Columns
Name | Type | Description |
---|---|---|
score | double precision | Denotes the score for this submission. Its value would be NULL when they are in the 'preview', 'untaken' OR 'settings_only' workflow states (since it is associated with quiz moderation events). Or its value should not be NULL when workflow state is either 'complete' or 'pending_review'. It defaults to NULL. |
kept_score | double precision | For quizzes that allow multiple attempts, this is the actual score that will be associated with the user for this quiz. This score depends on the scoring policy we have for the submission in the quiz submission dimension table, the workflow state being 'completed' or 'pending_review' and the allowed attempts to be greater than 1. Its value can be NULL when not all these required conditions are met. |
date | timestamp | Contains the same value as 'finished_at'. Provided to support backward compatibility with the existing table in production. |
course_id | bigint | Foreign key to the course this submission belongs to. |
enrollment_term_id | bigint | Foreign key to the enrollment term of the course this submission belongs to. |
course_account_id | bigint | Foreign key to the account of the course this submission belongs to. |
quiz_id | bigint | ID of the quiz the quiz submission represents. Foreign key to the quiz dimension table. |
assignment_id | bigint | Foreign key to the assignment the quiz belongs to. |
user_id | bigint | ID of the user (who is a student) who made the submission. Foreign key to the user dimension table. |
submission_id | bigint | ID to the submission the quiz submission represents. Foreign key to the quiz submission dimension table. |
enrollment_rollup_id | bigint | Foreign key to the enrollment roll-up dimension table. |
quiz_submission_historical_id | bigint | Foreign key to the quiz submission dimension table. |
quiz_points_possible | double precision | Maximum points that can be scored in this quiz. |
score_before_regrade | double precision | Original score of the quiz submission prior to any re-grading. It's NULL if the submission has never been regraded. Defaults to NULL. |
fudge_points | double precision | Number of points the quiz submission's score was fudged (changed) by. Values can be negative or positive. Defaults to 0. |
total_attempts | int | Denotes the total number of attempts made by the student for the quiz. Is valid only if the quiz allows multiple attempts. |
extra_attempts | int | Number of times the student was allowed to re-take the quiz over the multiple-attempt limit. |
extra_time | int | Amount of extra time allowed for the quiz submission, in minutes. |
time_taken | int | Time taken, in seconds, to finish the quiz. |
submission_comment_fact
Table contains measures related to the submission comments feature in Canvas.
Type: fact
Columns
Name | Type | Description |
---|---|---|
submission_comment_id | bigint | Foreign key to the submission comment dimension related to the comment |
submission_id | bigint | Foreign key to the submission dimension related to the comment |
recipient_id | bigint | [Deprecated] No longer used in Canvas, will always be NULL. |
author_id | bigint | Foreign key to the user dimension for the author of the comment |
assignment_id | bigint | Foreign key to assignment dimension |
course_id | bigint | Foreign key to course dimension of course associated with the assignment. |
enrollment_term_id | bigint | Foreign Key to enrollment term table |
course_account_id | bigint | Foreign key to the account dimension of the account associated with the course associated with the assignment |
message_size_bytes | int | The message size in bytes. |
message_character_count | int | The message size in characters. |
message_word_count | int | The message size in words using space and common punctuation as word breaks. |
message_line_count | int | The number of lines in a message. |
submission_fact
Type: fact
Columns
Name | Type | Description |
---|---|---|
submission_id | bigint | Foreign key to submission dimension |
assignment_id | bigint | Foreign key to assignment dimension |
course_id | bigint | Foreign key to course dimension of course associated with the assignment. |
enrollment_term_id | bigint | Foreign Key to enrollment term table |
user_id | bigint | Foreign key to user dimension of user who submitted the assignment. |
grader_id | bigint | Foreign key to the user dimension of user who graded the assignment. |
course_account_id | bigint | [Deprecated] No longer used in Canvas, will always be NULL. |
enrollment_rollup_id | bigint | Foreign key to the enrollment roll-up dimension table. |
score | double precision | Numeric grade given to the submission. |
published_score | double precision | Valid only for a graded submission. It reflects the numerical value of the actual score. Referring to our previous example for 'submission_dim.published_grade', let's take two submissions, one for an assignment with a scoring method of 'points' and the other for an assignment with a scoring method of 'letter grade'. If the published grade is '4' out of '5' and 'B' for them, respectively, then they should both have a score of '4' out of '5'. And their 'published_score' values will be identical, '4.0'. Defaults to 'NULL'. |
what_if_score | double precision | Valid only if the student ever entered a 'What If' score for an assignment in the Canvas UI. Only the most recent score entered by the student is stored here. Any time a new score is entered, the existing one is overwritten. Defaults to 'NULL'. |
submission_comments_count | int | Reflects the total number of comments on the submission by anyone/everyone, excluding comments that are flagged as 'hidden'. |
account_id | bigint | Foreign key to the account the submission belongs to. |
assignment_group_id | bigint | Foreign key to the assignment group dimension table. |
group_id | bigint | Foreign key to the group_dim table. |
quiz_id | bigint | Foreign key to the quiz the quiz submission associated with this submission represents. |
quiz_submission_id | bigint | Foreign key to the quiz_submission_dim table. |
wiki_id | bigint | Foreign key to the wiki_dim table. |
submission_file_fact
A junction table that associates files and submissions
Type: fact
Columns
Name | Type | Description |
---|---|---|
submission_file_id | bigint | Unique surrogate key for the file-submission association |
file_id | bigint | Foreign key to the file in this association |
submission_id | bigint | Foreign key to the submission in this association |
assignment_id | bigint | Foreign key to the assignment the submission is associated with |
user_id | bigint | Foreign key to the user who uploaded this file |
grader_id | bigint | Foreign key to the user who graded the submission in this assocation |
course_id | bigint | Foreign key to course associated with the submission. |
enrollment_term_id | bigint | Foreign Key to enrollment term associated with the submission's course |
wiki_fact
Measures for wikis.
Type: fact
Columns
Name | Type | Description |
---|---|---|
wiki_id | bigint | Foreign key to the wiki dimension. |
parent_course_id | bigint | Foreign key to the courses table if the wiki is associated with a Course. Otherwise this field is set to NULL. |
parent_group_id | bigint | Foreign key to the groups table if the wiki is associated with a Group. Otherwise this field is set to NULL. |
parent_course_account_id | bigint | Foreign key to the account dimension for the account associated with the wiki's course. If the wiki is not associated to a Course, this field is set to NULL. |
parent_group_account_id | bigint | Foreign key to the account dimension for the account associated with the wiki's group. If the wiki is not associated to a Group, this field is set to NULL. |
account_id | bigint | Foreign key to the accounts table that this wiki belongs to. Helpful for directly finding the account associated with the wiki, irrespective of whether it belongs to a Course or a Group. |
root_account_id | bigint | Root account Id of the account the wiki belongs to. Foreign key to the accounts table. |
enrollment_term_id | bigint | Foreign key to the enrollment term table of the course this wiki is associated with. Otherwise this is set to NULL. |
group_category_id | bigint | (Not implemented) Foreign key to the group categories table of the group this wiki is associated with. Otherwise this is set to NULL. |
wiki_page_fact
Measures for wiki pages.
Type: fact
Columns
Name | Type | Description |
---|---|---|
wiki_page_id | bigint | Foreign key to the wiki pages dimension. |
wiki_id | bigint | Foreign key to the wikis dimension. |
parent_course_id | bigint | Foreign key to the courses table if the wiki that owns the wiki page is associated with a Course. Otherwise this field is set to NULL. |
parent_group_id | bigint | Foreign key to the groups table if the wiki that owns the wiki page is associated with a Group. Otherwise this field is set to NULL. |
parent_course_account_id | bigint | Foreign key to the account dimension for the account associated with the wiki page's course. If the wiki page is not associated to a Course, this field is set to NULL. |
parent_group_account_id | bigint | Foreign key to the account dimension for the account associated with the wiki page's group. If the wiki page is not associated to a Group, this field is set to NULL. |
user_id | bigint | Foreign key to the user table. |
account_id | bigint | Foreign key to the accounts table that this wiki page belongs to. Helpful for directly finding the account associated with the wiki page, irrespective of whether it belongs to a Course or a Group. |
root_account_id | bigint | Root account Id of the account the wiki belongs to. Foreign key to the accounts table. |
enrollment_term_id | bigint | Foreign key to the enrollment term table of the course this wiki page is associated with. Otherwise this is set to NULL. |
group_category_id | bigint | (Not implemented) Foreign key to the group categories table of the group this wiki page is associated with. Otherwise this is set to NULL. |
wiki_page_comments_count | int | [Deprecated] No longer used in Canvas, will always be NULL. |
view_count | int | [Deprecated] No longer used in Canvas, will always be NULL. |
account_dim
An account object in the Canvas system. Accounts are most often used to represent a hierarchy of colleges, schools, departments, campuses, etc.
Type: dimension
Columns
Name | Type | Description |
---|---|---|
id | bigint | Unique surrogate id for an account |
canvas_id | bigint | Primary key for this entry in the Canvas accounts table |
name | varchar | Name of the account |
depth | int | Depth of the account in the hierarchy. The root node is at 0. |
workflow_state | varchar | Workflow status indicating that account is [deleted] or [active] |
parent_account | varchar | Name of this account's parent account. This field will be NULL for the root account. |
parent_account_id | bigint | Id of this account's parent account. This field will be NULL for the root account. |
grandparent_account | varchar | Name of this account's grand parent account. This field will be NULL for the root account and all accounts at level 1. |
grandparent_account_id | bigint | Id of this account's grand parent account. This field will be NULL for the root account and all subaccounts at level 1. |
root_account | varchar | Name of the root account associated with this account. |
root_account_id | bigint | Id of the root account associated with this account. |
subaccount1 | varchar | Name of this account's parent at subaccount level 1. If this account is a level 1 account, this will be the name of this account. |
subaccount1_id | bigint | Id of this account's parent at subaccount level 1. If this account is a level 1 account, this will be the id of this account. |
subaccount2 | varchar | Name of this account's parent at subaccount level 2. If this account is a level 2 account, subaccount2 will be the name of this account. |
subaccount2_id | bigint | Id of this account's parent at subaccount level 2. If this account is a level 2 account, subaccount2_id will be the id of this account. |
subaccount3 | varchar | Name of this account's parent at subaccount level 3. If this account is a level 3 account, subaccount3 will be the name of this account. |
subaccount3_id | bigint | Id of this account's parent at subaccount level 3. If this account is a level 3 account, subaccount3_id will be the id of this account. |
subaccount4 | varchar | Name of this account's parent at subaccount level 4. If this account is a level 4 account, subaccount4 will be the name of this account. |
subaccount4_id | bigint | Id of this account's parent at subaccount level 4. If this account is a level 4 account, subaccount4_id will be the id of this account. |
subaccount5 | varchar | Name of this account's parent at subaccount level 5. If this account is a level 5 account, subaccount5 will be the name of this account. |
subaccount5_id | bigint | Id of this account's parent at subaccount level 5. If this account is a level 5 account, subaccount5_id will be the id of this account. |
subaccount6 | varchar | Name of this account's parent at subaccount level 6. If this account is a level 6 account, subaccount6 will be the name of this account. |
subaccount6_id | bigint | Id of this account's parent at subaccount level 6. If this account is a level 6 account, subaccount6_id will be the id of this account. |
subaccount7 | varchar | Name of this account's parent at subaccount level 7. If this account is a level 7 account, subaccount7 will be the name of this account. |
subaccount7_id | bigint | Id of this account's parent at subaccount level 7. If this account is a level 7 account, subaccount7_id will be the id of this account. |
subaccount8 | varchar | Name of this account's parent at subaccount level 8. If this account is a level 8 account, subaccount8 will be the name of this account. |
subaccount8_id | bigint | Id of this account's parent at subaccount level 8. If this account is a level 8 account, subaccount8_id will be the id of this account. |
subaccount9 | varchar | Name of this account's parent at subaccount level 9. If this account is a level 9 account, subaccount9 will be the name of this account. |
subaccount9_id | bigint | Id of this account's parent at subaccount level 9. If this account is a level 9 account, subaccount9_id will be the id of this account. |
subaccount10 | varchar | Name of this account's parent at subaccount level 10. If this account is a level 10 account, subaccount10 will be the name of this account. |
subaccount10_id | bigint | Id of this account's parent at subaccount level 10. If this account is a level 10 account, subaccount10_id will be the id of this account. |
subaccount11 | varchar | Name of this account's parent at subaccount level 11. If this account is a level 11 account, subaccount11 will be the name of this account. |
subaccount11_id | bigint | Id of this account's parent at subaccount level 11. If this account is a level 11 account, subaccount11_id will be the id of this account. |
subaccount12 | varchar | Name of this account's parent at subaccount level 12. If this account is a level 12 account, subaccount12 will be the name of this account. |
subaccount12_id | bigint | Id of this account's parent at subaccount level 12. If this account is a level 12 account, subaccount12_id will be the id of this account. |
subaccount13 | varchar | Name of this account's parent at subaccount level 13. If this account is a level 13 account, subaccount13 will be the name of this account. |
subaccount13_id | bigint | Id of this account's parent at subaccount level 13. If this account is a level 13 account, subaccount13_id will be the id of this account. |
subaccount14 | varchar | Name of this account's parent at subaccount level 14. If this account is a level 14 account, subaccount14 will be the name of this account. |
subaccount14_id | bigint | Id of this account's parent at subaccount level 14. If this account is a level 14 account, subaccount14_id will be the id of this account. |
subaccount15 | varchar | Name of this account's parent at subaccount level 15. If this account is a level 15 account, subaccount15 will be the name of this account. |
subaccount15_id | bigint | Id of this account's parent at subaccount level 15. If this account is a level 15 account, subaccount15_id will be the id of this account. |
sis_source_id | varchar | Correlated id for the record for this course in the SIS system (assuming SIS integration is configured) |
assignment_dim
Attributes for for assignments. There is one record in this table for each assignment. Individual submissions of the assignment are in the submission_dim and submission_fact tables.
Type: dimension
Columns
Name | Type | Description |
---|---|---|
id | bigint | Unique surrogate ID for the assignment. |
canvas_id | bigint | Primary key for this record in the Canvas assignments table. |
course_id | bigint | Foreign key to the course associated with this assignment |
title | varchar | Title of the assignment |
description | text | Long description of the assignment |
due_at | timestamp | Timestamp for when the assignment is due |
unlock_at | timestamp | Timestamp for when the assignment is unlocked or visible to the user |
lock_at | timestamp | Timestamp for when the assignment is locked |
points_possible | double precision | Total points possible for the assignment |
grading_type | varchar | Describes how the assignment will be graded (gpa_scale, pass_fail, percent, points, not_graded, letter_grade) |
submission_types | varchar | Comma separated list of valid methods for submitting the assignment (online_url, media_recording, online_upload, online_quiz, external_tool, online_text_entry, online_file_upload) |
workflow_state | varchar | Current workflow state of the assignment. Possible values are unpublished, published and deleted |
created_at | timestamp | Timestamp of the first time the assignment was entered into the system |
updated_at | timestamp | Timestamp of the last time the assignment was updated |
peer_review_count | int | The number of pears to assign for review if using algorithmic assignment |
peer_reviews_due_at | timestamp | Timestamp for when peer reviews should be completed |
peer_reviews_assigned | boolean | True if all peer reviews have been assigned |
peer_reviews | boolean | True if peer reviews are enabled for this assignment |
automatic_peer_reviews | boolean | True if peer reviews are assigned algorithmically (vs. letting the instructor make manual assignments) |
all_day | boolean | True if A specific time for when the assignment is due was not given. The effective due time will be 11:59pm. |
all_day_date | date | The date version of the due date if the all_day flag is true. |
could_be_locked | boolean | True if the assignment is under a module that can be locked |
grade_group_students_individually | boolean | True if students who submit work as a group will each receive individual grades (vs one grade that is copied to all group members) |
anonymous_peer_reviews | boolean | (currently unimplemented, do not use) |
muted | boolean | [Deprecated] No longer used in Canvas, will always be NULL. |
assignment_group_id | bigint | Foreign key to the assignment group dimension table. |
position | integer | The sorting order of the assignment in the group |
visibility | enum | User sets that can view the assignment. Possible values ('everyone', 'only_visible_to_overrides') |
external_tool_id | bigint | Foreign key to the external tool activation if this assignment uses an external tool for submissions. |
assignment_group_dim
Attributes for assignment_groups.
Type: dimension
Columns
Name | Type | Description |
---|---|---|
id | bigint | Unique surrogate ID for the assignment group. |
canvas_id | bigint | Primary key for this record in the Canvas assignment_groups table. |
course_id | bigint | Foreign key to the course to which the assignment group belongs to. |
name | varchar | Name of the assignment group. Defaults to 'Assignments' if no name is provided during group creation. |
default_assignment_name | varchar | Default name assigned to the assignments in the assignment group if no name is assigned to them during their creation. Also, it is the singularized version of the assignment group name by default (if it's in English). |
workflow_state | varchar | Current workflow state of the assignment groups. Possible values are 'available' and 'deleted'. |
position | integer | Position of the assignment group in the assignment index page. It determines where it should be displayed on the page and where it should be displayed in a new course if the course is cloned. |
created_at | timestamp | Date/Time when the assignment group was created. |
updated_at | timestamp | Date/Time when the assignment group was last updated. |
assignment_group_rule_dim
Rules associated with an assignment group.
Type: dimension
Columns
Name | Type | Description |
---|---|---|
assignment_group_id | bigint | Foreign key to the assignment group dimension table. |
drop_lowest | integer | Number of lowest scored assignments which can be dropped from the group. Set to '0' when none should be dropped. Defauts to '0'. |
drop_highest | integer | Number of highest scored assignments which can be dropped form the group. Set to '0' when none should be dropped. Defaults to '0'. |
assignment_group_score_dim
Attributes for Assignment Group scores. You can think of a score as synonymous with a cell inside the gradebook.
Type: dimension
Columns
Name | Type | Description |
---|---|---|
id | bigint | Unique surrogate identifier for the score. |
canvas_id | bigint | Primary key for the score. |
assignment_group_id | bigint | Foreign key to the assignment group table. |
enrollment_id | bigint | Foreign key to the Enrollment table. |
created_at | timestamp | Timestamp when record was created. |
updated_at | timestamp | Timestamp when record was last updated. |
workflow_state | enum | Workflow state for the score. Possible values are 'active', 'deleted' |
assignment_override_dim
Attributes for assignment_override. There may be many records in this table for each assignment. Use the data in this table to calculate actual due, all_day, lock and unlock dates/times.
Type: dimension
Columns
Name | Type | Description |
---|---|---|
id | bigint | Unique surrogate ID for the assignment override. |
canvas_id | bigint | Primary key for this record in the Canvas assignments table. |
assignment_id | bigint | Foreign key to the assignment the override is associated with. May be empty. |
course_section_id | bigint | Foreign key to the course_section. |
group_id | bigint | Foreign key to the group. |
quiz_id | bigint | Foreign key to the quiz the override is associated with. |
all_day | enum | Indicates if the all_day field overrides the original assignment.all_day field for this group of users. Possible values are 'new_all_day' and 'same_all_day'. |
all_day_date | date | The new date version of the due date if the all_day flag is true. |
assignment_version | int | The version of the assignment this override is applied too. |
created_at | timestamp | Timestamp of when the assignment_override was created. |
due_at | timestamp | The new due_at date-time for this group of users. |
due_at_overridden | enum | Indicates if the due_at field overrides the original assignment.due_at field for this group of users. Possible values are 'new_due_at' and 'same_due_at'. |
lock_at | timestamp | The new lock_at date-time for this group of users. |
lock_at_overridden | enum | Indicates if the lock_at field overrides the original assignment.lock_at field for this group of users. Possible values are 'new_lock_at' and 'same_lock_at'. |
set_type | enum | Used in conjunction with set_id, this field tells us what type of foreign relation is used. Possible values are 'course_section', 'group' and 'adhoc'. |
title | text | The title for this assignment_override. |
unlock_at | timestamp | The new unlock_at date-time for this group of users. |
unlock_at_overridden | enum | Indicates if the unlock_at field overrides the original assignment.unlock_at field for this group of users. Possible values are 'new_unlock_at' and 'same_unlock_at'. |
updated_at | timestamp | Timestamp of when the assignment_override was last updated. |
quiz_version | int | The version of the quiz this override is applied too. |
workflow_state | enum | Gives the workflow state of this record. Possible values are 'active' and 'deleted'. |
assignment_override_user_dim
Table contains measures related to adhoc users for whom an assignment override exists.
Type: dimension
Columns
Name | Type | Description |
---|---|---|
id | bigint | Unique surrogate ID for the assignment_override_student. |
canvas_id | bigint | The ID of the user in the adhoc group table. |
assignment_id | bigint | Foreign key to the assignment the override is associated with. May be empty. |
assignment_override_id | bigint | Foreign key to the assignment override dimension |
quiz_id | bigint | Foreign key to the quiz the override is associated with. May be empty. |
user_id | bigint | Foreign key to the user. |
created_at | timestamp | Timestamp of when the assignment_override_student was created. |
updated_at | timestamp | Timestamp of when the assignment_override_student was last updated. |
assignment_rule_dim
Rules associated with an assignment.
Type: dimension
Columns
Name | Type | Description |
---|---|---|
assignment_id | bigint | ID of the assignment which can never be dropped from the group. |
drop_rule | varchar | Denotes if the assignment can be dropped from the assignment group if the group allows dropping assignments based on certain rules. Is set to 'never_drop' if the assignment is exempted from dropping, else set to 'can_be_dropped'. |
catalog_applicant_dim
Attributes for catalog applicants
Type: dimension
Columns
Name | Type | Description |
---|---|---|
id | bigint | Unique surrogate key for the catalog applicant |
catalog_id | bigint | Foreign key to the catalog dim. Refers to the catalog this applicant belongs to |
catalog_product_id | bigint | Foreign key to the catalog product dim. Refers to the course or program associated with the applicant |
user_id | bigint | Foreign key to the user dim. Refers to the catalog applicant |
notified_of_opening_at | timestamp | If present, indicates when the applicant was notified of an opening in the course or program |
activated | boolean | Indicates whether the user's catalog account has been activated. If true, the user's account has been activated; otherwise, the user's account has not been activated |
status | varchar | Indicates the applicant's enrollment status for the course or program. Possible values are "waitlist", "accepted", "declined", "expired", "error" |
created_at | timestamp | Time when the applicant was created |
updated_at | timestamp | Time when the applicant was last updated |
catalog_dim
Attributes for catalogs in Canvas Catalog
Type: dimension
Columns
Name | Type | Description |
---|---|---|
id | bigint | Unique surrogate ID for the catalog |
parent_id | bigint | Self-referencing key that points to the parent catalog for this catalog. Null if this catalog has no parent |
name | varchar | Name of the catalog |
currency | varchar | Type of currency used in the catalog |
country | varchar | Country used in this catalog |
time_zone | varchar | Timezone used in this catalog |
created_at | timestamp | When the catalog was created |
updated_at | timestamp | When the catalog was last updated |
catalog_enrollment_dim
Attributes for an enrollment in a Canvas Catalog program or course
Type: dimension
Columns
Name | Type | Description |
---|---|---|
id | bigint | Unique surrogate key for the catalog enrollment |
catalog_product_id | bigint | Foreign key to the catalog product dim. Refers to the course or program associated with the enrollment |
user_id | bigint | Foreign key to the user dim. Refers to the user associated with this enrollment |
root_program_id | bigint | Foreign key to the catalog product dim. Refers to the root program associated with this enrollment |
status | varchar | The status of the enrollment. One of either "active" or "dropped" |
requirements_completed_at | timestamp | Time when the user completed all requirements for the course or program. Null if the requirements have not yet been met |
ends_at | timestamp | Time by which the user must complete the course or program requirements. Null if there is no required end date |
created_at | timestamp | Time when the enrollment record was created |
updated_at | timestamp | Time when the enrollment record was last updated |
catalog_order_dim
Attributes for Catalog orders
Type: dimension
Columns
Name | Type | Description |
---|---|---|
id | bigint | Unique surrogate key for the catalog order |
catalog_id | bigint | Foreign key to the catalog dim |
user_id | bigint | Foreign key to the user dim. Refers to the user associated with this order |
full_id | varchar | The id of the order prepended with the Catalog-specified order id prefix, if provided by customers. If not prefixed, full_id will match the order id |
purchased_at | timestamp | When the catalog order was fulfilled |
created_at | timestamp | When the catalog order was created |
updated_at | timestamp | When the catalog order was last updated |
currency | varchar | Type of currency used in the catalog order |
catalog_order_item_dim
Attributes for Catalog order items
Type: dimension
Columns
Name | Type | Description |
---|---|---|
id | bigint | Unique surrogate key for the catalog order item |
catalog_order_id | bigint | Foreign key to the catalog order dim |
catalog_product_id | bigint | Foreign key to the catalog product dim. Refers to the course or program associated with this order item |
catalog_promotion_id | bigint | Foreign key to the catalog promotion dim |
created_at | timestamp | When the catalog order item was created |
updated_at | timestamp | When the catalog order item was last updated |
catalog_payment_dim
Attributes for Catalog payments
Type: dimension
Columns
Name | Type | Description |
---|---|---|
id | bigint | Unique surrogate key for the catalog payment |
catalog_id | bigint | Foreign key to the catalog dim. Refers to the catalog this payment belongs to |
catalog_order_id | bigint | Foreign key to the catalog order dim |
status | varchar | The payment status. Can be one of "success", "pending", or "error" |
reference_id | varchar | The transaction reference ID from the payment merchant |
created_at | timestamp | Time when the payment was created |
updated_at | timestamp | Time when the payment was updated |
catalog_product_dim
Attributes for products in Canvas Catalog. A product can be either a course or a program listing
Type: dimension
Columns
Name | Type | Description |
---|---|---|
id | bigint | Unique surrogate key for the catalog product |
catalog_id | bigint | Foreign key to the catalog dim |
start_date | timestamp | The start date for the course or program |
end_date | timestamp | The end date for the course or program |
course_id | bigint | Foreign key to the course dim if this product is a course |
product_type | varchar | Can be either "Program" or "Course" |
title | varchar | The title of the course or program listing |
visibility | varchar | Can be one of "listed", "unlisted", or "hidden" |
enrollment_open | boolean | Whether the course or program is open for enrollment |
has_waitlist | boolean | Whether the course or program has a waitlist |
created_at | timestamp | The date when the product was created |
updated_at | timestamp | The date when the product was last updated |
catalog_product_tag_dim
Attributes for Catalog product tags
Type: dimension
Columns
Name | Type | Description |
---|---|---|
id | bigint | Unique surrogate key for the catalog product tag |
catalog_id | bigint | Foreign key to the catalog dim. Refers to the catalog that this product tag belongs to |
catalog_product_id | bigint | Foreign key to the associated course or program from the catalog product dim |
catalog_tag_id | bigint | Foreign key to the associated tag from the catalog tag dim |
created_at | timestamp | Time when this product tag was created |
updated_at | timestamp | Time when this product tag was updated |
catalog_promotion_dim
Attributes for Catalog promotions
Type: dimension
Columns
Name | Type | Description |
---|---|---|
id | bigint | Unique surrogate key for the catalog promotion |
catalog_id | bigint | Foreign key to the catalog dim. Refers to the catalog this promotion belongs to |
catalog_product_id | bigint | Foreign key to the associated course or program from the catalog product dim. If null, this promotion is available for all courses or programs in the catalog |
discount_type | varchar | The type of discount. Can be either "flat" or "percent" |
code | varchar | The code used to redeem the promotion |
name | varchar | The name of the promotion |
usage_type | varchar | Indicates whether the promotion is "unlimited" or "once-per-user" |
start_date | timestamp | The time the promotion begins |
end_date | timestamp | The time the promotion ends |
active | boolean | Whether or not the promotion is active |
created_at | timestamp | Time when the promotion was created |
updated_at | timestamp | Time when the promotion was updated |
catalog_tag_dim
Attributes for Catalog tags
Type: dimension
Columns
Name | Type | Description |
---|---|---|
id | bigint | Unique surrogate key for the catalog tag |
catalog_id | bigint | Foreign key to the catalog dim. Refers to the catalog that this tag belongs to |
name | varchar | The catalog tag text |
created_at | timestamp | Time when the tag was created |
updated_at | timestamp | Time when the tag was updated |
catalog_user_registration_dim
Attributes for user registration in a Canvas Catalog. See catalog_enrollment for data about programs and courses the user is enrolled in
Type: dimension
Columns
Name | Type | Description |
---|---|---|
id | bigint | Unique surrogate key for the catalog user registration |
catalog_id | bigint | Foreign key to the catalog dim. Refers to the catalog that this registration belongs to |
user_id | bigint | Foreign key to the user dim. Refers to the registered user |
created_at | timestamp | Time when the user registration record was created |
updated_at | timestamp | Time when the user registration record was last updated |
communication_channel_dim
Attributes for communication channel.
Type: dimension
Columns
Name | Type | Description |
---|---|---|
id | bigint | Unique surrogate ID for the communication channel. |
canvas_id | bigint | Primary key for this communication channel in the communication_channel table. |
user_id | bigint | Foreign key to the user that owns this communication channel. |
address | varchar | Address, or path, of the communication channel. Set to 'NULL' for push notifications. |
type | varchar | Denotes the type of the path. Possible values are 'email', 'facebook', 'push' (device push notifications), 'sms' and 'twitter'. Defaults to 'email'. |
position | integer | Position of this communication channel relative to the user's other channels when they are ordered. |
workflow_state | varchar | Current state of the communication channel. Possible values are 'unconfirmed', 'active', and 'retired'. |
created_at | timestamp | Date/Time when the communication channel was created. |
updated_at | timestamp | Date/Time when the communication channel was last updated. |
conference_dim
Attributes for conferences
Type: dimension
Columns
Name | Type | Description |
---|---|---|
id | bigint | Unique surrogate id for the conference |
canvas_id | bigint | Primary key for this conference in the web_conferences table |
title | varchar | The title of the conference |
conference_type | varchar | The type of the conference (e.g. 'AdobeConnect', 'BigBlueButton') |
group_id | bigint | Foreign key to the group if this conference was associated with a group |
course_id | bigint | Foreign key to the course if this conference was associated with a course |
account_id | bigint | Foreign key to the account if this conference was associated with an account |
start_at | timestamp | The time at which this conference was scheduled to begin |
started_at | timestamp | The time at which this conference actually started at, null if it hasn't started |
end_at | timestamp | The time at which this conference was scheduled to end |
ended_at | timestamp | The time at which this conference actually ended, null if it hasn't ended |
created_at | timestamp | |
updated_at | timestamp |
conference_participant_dim
Attributes for conference participants
Type: dimension
Columns
Name | Type | Description |
---|---|---|
id | bigint | Unique surrogate key for a conference participant |
user_id | bigint | Foreign key to the user who is the conference participant |
conference_id | bigint | Foreign key to the conference |
participation_type | varchar | Type of participation, ('invitee' or 'attendee') |
created_at | timestamp | |
updated_at | timestamp |
conversation_dim
Attributes for a conversation
Type: dimension
Columns
Name | Type | Description |
---|---|---|
id | bigint | Unique surrogate id for the conversation. |
canvas_id | bigint | Original primary key for conversation in the Canvas table |
has_attachments | boolean | True if the conversation has attachments |
has_media_objects | boolean | True if the conversation has media objects |
subject | varchar | The subject of the conversation |
course_id | bigint | The course that owns this conversation |
group_id | bigint | The group that owns this conversation |
account_id | bigint | The account this owns this conversation |
conversation_message_dim
Attributes for a message in a conversation
Type: dimension
Columns
Name | Type | Description |
---|---|---|
id | bigint | Unique surrogate id for the message. |
canvas_id | bigint | Original ID for canvas table. |
conversation_id | bigint | Parent conversation for this message. |
author_id | bigint | User id of the author of the message. |
created_at | timestamp | Date and time this message was created. |
generated | boolean | This attribute is true if the system generated this message (e.g. "John was added to this conversation") |
has_attachments | boolean | True if the message has attachments. |
has_media_objects | boolean | True if the message has media objects. |
body | text | The content of the message. |
course_dim
A course in the canvas system
Type: dimension
Columns
Name | Type | Description |
---|---|---|
id | bigint | Unique surrogate id for a course |
canvas_id | bigint | Primary key for this course in the canvas courses table. |
root_account_id | bigint | The root account associated with this course. |
account_id | bigint | The parent account for this course. |
enrollment_term_id | bigint | Foreign key to enrollment term table |
name | varchar | The friendly name of the course. |
code | varchar | The code for the course (e.g. FA12 MATH 2000) |
type | varchar | [Deprecated] No longer used in Canvas, will always be NULL. |
created_at | timestamp | Timestamp when the course object was created in Canvas |
start_at | timestamp | Timestamp for when the course starts. |
conclude_at | timestamp | Timestamp for when the course finishes |
publicly_visible | boolean | True if the course is publicly visible |
sis_source_id | varchar | Correlated id for the record for this course in the SIS system (assuming SIS integration is configured) |
workflow_state | varchar | Workflow status indicating the current state of the course, valid values are: completed (course has been hard concluded), created (course has been created, but not published), deleted (course has been deleted), available (course is published, and not hard concluded), claimed (course has been undeleted, and is not published). |
wiki_id | bigint | Foreign key to the wiki_dim table. |
syllabus_body | text | Content of the syllabus for this course. |
course_score_dim
Attributes for course scores. You can think of a score as synonymous with a cell inside the gradebook.
Type: dimension
Columns
Name | Type | Description |
---|---|---|
id | bigint | Unique surrogate identifier for the score. |
canvas_id | bigint | Primary key for the score. |
enrollment_id | bigint | Foreign key to the Enrollment table. |
created_at | timestamp | Timestamp when record was created. |
updated_at | timestamp | Timestamp when record was last updated. |
workflow_state | enum | Workflow state for the score. Possible values are 'active', 'deleted' |
course_section_dim
Attributes for a section of a course
Type: dimension
Columns
Name | Type | Description |
---|---|---|
id | bigint | Unique surrogate id for the course section. |
canvas_id | bigint | Primary key for this record in the Canvas course_sections table. |
name | varchar | Name of the section |
course_id | bigint | Foreign key to the associated course |
enrollment_term_id | bigint | Foreign key to the associated enrollment term |
default_section | boolean | True if this is the default section |
accepting_enrollments | boolean | True if this section is open for enrollment |
can_manually_enroll | boolean | [Deprecated] No longer used in Canvas, will always be NULL. |
start_at | timestamp | Section start date |
end_at | timestamp | Section end date |
created_at | timestamp | Timestamp for when this section was entered into the system. |
updated_at | timestamp | Timestamp for when the last time the section was updated |
workflow_state | varchar | Life-cycle state for section. (active, deleted) |
restrict_enrollments_to_section_dates | boolean | True when "Users can only participate in the course between these dates" is checked |
nonxlist_course_id | bigint | The course id for the original course if this course has been cross listed |
sis_source_id | varchar | Id for the correlated record for the section in the SIS (assuming SIS integration has been properly configured) |
course_ui_canvas_navigation_dim
Attributes for a Canvas navigation function
Type: dimension
Columns
Name | Type | Description |
---|---|---|
id | bigint | Primary key for navigational item |
canvas_id | bigint | ID in Canvas system |
name | varchar | Name of navigational item |
default | varchar | (Default|NotDefault) - set to Default if this is one of the navigation items enabled in a course by default |
original_position | varchar | Original position of this navigation item |
course_ui_navigation_item_dim
Attributes for a navigation item
Type: dimension
Columns
Name | Type | Description |
---|---|---|
id | bigint | Primary key for navigational item |
root_account_id | bigint | Foreign key to root account of the course |
visible | varchar | (visible|hidden) Visible if this element is visible, hidden if hidden/not available in the navigation |
position | int | Position in the navigation. NULL if hidden. |
discussion_entry_dim
Attributes for discussion entries. Discussion entries are replies in a discussion topic.
Type: dimension
Columns
Name | Type | Description |
---|---|---|
id | bigint | Unique surrogate id for the discussion entry. |
canvas_id | bigint | Primary key for this record in the Canvas discussion_entries table |
message | text | Full text of the entry's message |
workflow_state | varchar | Workflow state for discussion message (values: deleted, active) |
created_at | timestamp | Timestamp when the discussion entry was created. |
updated_at | timestamp | Timestamp when the discussion entry was updated. |
deleted_at | timestamp | Timestamp when the discussion entry was deleted. |
depth | int | Reply depth for this entry |
discussion_topic_dim
Attributes for discussion topics in Canvas. Discussion topics are logical discussion threads. They can have many discussion entries. They also have their own message text for the message that started the topic.
Type: dimension
Columns
Name | Type | Description |
---|---|---|
id | bigint | Unique surrogate id for the discussion topic. |
canvas_id | bigint | Primary key to the discussion_topics table in Canvas |
title | varchar | Title of the discussion topic |
message | text | Message text for the discussion topic. |
type | varchar | Discussion topic type. Two types are default (blank) and announcement. |
workflow_state | varchar | Workflow state for this discussion topic. Valid states are unpublished, active, locked, deleted, and post_delayed |
last_reply_at | timestamp | Timestamp of the last reply to this topic. |
created_at | timestamp | Timestamp when the discussion topic was first saved in the system. |
updated_at | timestamp | Timestamp when the discussion topic was last updated in the system. |
delayed_post_at | timestamp | Timestamp when the discussion topic was/will be delay-posted |
posted_at | timestamp | Timestamp when the discussion topic was posted |
deleted_at | timestamp | Timestamp when the discussion topic was deleted. |
discussion_type | varchar | Type of discussion topic: default(blank), side_comment, threaded. threaded indicates that replies are threaded where side_comment indicates that replies in the discussion are flat. See related Canvas Guide https://guides.instructure.com/m/4152/l/60423-how-do-i-create-a-threaded-discussion |
pinned | boolean | True if the discussion topic has been pinned |
locked | boolean | True if the discussion topic has been locked |
course_id | bigint | Foreign key to the course dimension |
group_id | bigint | Foreign key to the group dimension |
enrollment_dim
An enrollment represents a user's association with a specific course and section
Type: dimension
Columns
Name | Type | Description |
---|---|---|
id | bigint | Unique surrogate id for the enrollment. |
canvas_id | bigint | Primary key for this record in the Canvas enrollments table |
root_account_id | bigint | Root account id associated with this enrollment |
course_section_id | bigint | Foreign key to the course section for this enrollment |
role_id | bigint | Foreign key to the role of the person enrolled in the course |
type | varchar | Enrollment type: TaEnrollment, DesignerEnrollment, StudentEnrollment, TeacherEnrollment, StudentViewEnrollment, ObserverEnrollment |
workflow_state | varchar | Workflow state for enrollment: active, completed, creation_pending, deleted, inactive, invited, rejected |
created_at | timestamp | Timestamp for when this section was entered into the system. |
updated_at | timestamp | Timestamp for when the last time the section was updated |
start_at | timestamp | Enrollment start date |
end_at | timestamp | Enrollment end date |
completed_at | timestamp | Enrollment completed date |
self_enrolled | boolean | Enrollment was created via self-enrollment |
sis_source_id | varchar | [Deprecated] No longer used in Canvas, will always be NULL. |
course_id | bigint | Foreign key to course for this enrollment |
user_id | bigint | Foreign key to user for the enrollment |
last_activity_at | timestamp | Last time the enrolled user viewed content or took action in the enrolled course |
enrollment_rollup_dim
Would be an empty table. Roll-up aggregating the roles held by the users in the courses they are associated with.
Type: dimension
Columns
Name | Type | Description |
---|---|---|
id | bigint | Unique surrogate id for the user and the course. |
user_id | bigint | Foreign key to the enrolled user. |
course_id | bigint | Foreign key to the enrolled course. |
enrollment_count | int | Total number of enrollments associated with the user in the course for his/her all roles under all base roles, duplicate or not. |
role_count | int | Total number of unique roles associated with the user in the course. |
base_role_count | int | Total number of unique base roles associated with the user in the course. |
account_admin_role_count | int | Total number of 'AccountAdmin' roles associated with the user in the course. |
teacher_enrollment_role_count | int | Total number of 'TeacherEnrollment' roles associated with the user in the course. |
designer_enrollment_role_count | int | Total number of 'DesignerEnrollment' roles associated with the user in the course. |
ta_enrollment_role_count | int | Total number of 'TaEnrollment' roles associated with the user in the course. |
student_enrollment_role_count | int | Total number of 'StudentEnrollment' roles associated with the user in the course. |
observer_enrollment_role_count | int | Total number of 'ObserverEnrollment' roles associated with the user in the course. |
account_membership_role_count | int | Total number of 'AccountMembership' roles associated with the user in the course. |
no_permissions_role_count | int | Total number of 'NoPermissions' roles associated with the user in the course. |
account_admin_enrollment_id | bigint | Enrollment ID if this a valid role for the user in the course, else NULL. |
teacher_enrollment_enrollment_id | bigint | Enrollment ID if this a valid role for the user in the course, else NULL. |
designer_enrollment_enrollment_id | bigint | Enrollment ID if this a valid role for the user in the course, else NULL. |
ta_enrollment_enrollment_id | bigint | Enrollment ID if this a valid role for the user in the course, else NULL. |
student_enrollment_enrollment_id | bigint | Enrollment ID if this a valid role for the user in the course, else NULL. |
observer_enrollment_enrollment_id | bigint | Enrollment ID if this a valid role for the user in the course, else NULL. |
account_membership_enrollment_id | bigint | Enrollment ID if this a valid role for the user in the course, else NULL. |
no_permissions_enrollment_id | bigint | Enrollment ID if this a valid role for the user in the course, else NULL. |
most_privileged_role | varchar | The most privileged role associated with the user in the course. |
least_privileged_role | varchar | The least privileged role associated with the user in the course. |
enrollment_term_dim
Enrollment term describes the term or semester associated with courses (e.g. Fall 2013)
Type: dimension
Columns
Name | Type | Description |
---|---|---|
id | bigint | Unique surrogate id for the enrollment term. |
canvas_id | bigint | Primary key for this record in the Canvas enrollments table. |
root_account_id | bigint | Foreign key to the root account for this enrollment term |
name | varchar | Name of the enrollment term |
date_start | timestamp | Term start date |
date_end | timestamp | Term end date |
sis_source_id | varchar | Correlated SIS id for this enrollment term (assuming SIS has been configured properly) |
external_tool_activation_dim
Attributes for external tool (LTI) activations. Note that activations can happen on courses or accounts. If this activation is associated with a course then course_id, course_account_id and enrollment_term_id will be populated. If this activation is associated with an account then only account_id will be populated.
Type: dimension
Columns
Name | Type | Description |
---|---|---|
id | bigint | Unique surrogate id for tool activations |
canvas_id | bigint | Primary key for this record in the context_external_tools table in the Canvas database |
course_id | bigint | Foreign key to the course if this tool was activated in a course |
account_id | bigint | Foreign key to the account this tool was activated in if it was activated in an account |
activation_target_type | varchar | The type of object the tool was activated in, (course or account) |
url | varchar | The URL to where the tool may launch to |
name | varchar | The name of tool activation as entered by the user |
description | varchar | The description of the tool activation as entered by the user |
workflow_state | varchar | Workflow state for activation (active, deleted) |
privacy_level | varchar | Privacy setting for activation (name_only, email_only, anonymous, public) |
created_at | timestamp | Timestamp when the activation was created |
updated_at | timestamp | Timestamp when the activation was last updated |
tool_id | varchar | The tool id received from the external tool. May be missing if the tool does not send an id. |
selectable_all | boolean | true - tool is selectable in all scenarios. false - not selectable for assignment or module selection menu |
file_dim
Attributes for files.
Type: dimension
Columns
Name | Type | Description |
---|---|---|
id | bigint | Unique surrogate ID for this file. |
canvas_id | bigint | Primary key for this file in the attachments table. |
display_name | text | Name of this file. |
account_id | bigint | Foreign key to the account this file belongs to. |
assignment_id | bigint | Foreign key to the assignment this file belongs to. |
conversation_message_id | bigint | Foreign key to the conversation message this file belongs to. |
course_id | bigint | Foreign key to the course this file belongs to. |
folder_id | bigint | Foreign key to the folder this file belongs to. |
group_id | bigint | Foreign key to the group this file belongs to. |
quiz_id | bigint | Foreign key to the quiz this file belongs to. |
quiz_submission_id | bigint | Foreign key to the quiz submission this file belongs to. |
replacement_file_id | bigint | ID of the overwriting file if this file is overwritten. |
root_file_id | bigint | ID of the source file from which this file was copied and created. Set to 'NULL' when this is the only copy. |
submission_id | bigint | Foreign key to the submission this file belongs to if the file's context was a submission or quiz submission. A file's context is an independent attribute from its relationship with a submission. Files have a many-to-many relationship with submissions in Canvas which requires a junction table to represent. See submission_file_fact for details on the junction table that links files to submissions. |
uploader_id | bigint | Foreign key to the user who uploaded this file. Might contain users which are not in the user dimension table. |
user_id | bigint | Foreign key to the user this file belongs to. |
owner_entity_type | enum | Table this file is associated with. Possible values are 'account', 'assignment', 'conversation_message', 'course', 'group', 'quiz', 'quiz_submission', 'submission' and 'user'. |
content_type | varchar | Contains the MIME type of this file. |
md5 | varchar | Contains the MD5 checksum of the contents of this file. |
file_state | enum | Denotes the current state of this file. Possible values are 'available', 'broken', 'deleted', 'errored' and 'hidden'. |
could_be_locked | enum | Dictates if the quiz can be locked or not. Possible values are 'allow_locking' and 'disallow_locking'. |
locked | enum | Denotes the current lock status of this file. Possible values are 'is_locked' and 'is_not_locked'. |
lock_at | timestamp | Date/Time when this file is to be locked. |
unlock_at | timestamp | Date/Time when this file is to unlocked. |
viewed_at | timestamp | Date/Time when this file was last viewed. |
created_at | timestamp | Date/Time when this file was created. |
updated_at | timestamp | Date/Time when this file was last updated. |
deleted_at | timestamp | Date/Time when this file was deleted. |
grading_period_dim
Attributes for grading period. A Grading period is like a "term", essentially used for splitting up the grade book into "periods"
Type: dimension
Columns
Name | Type | Description |
---|---|---|
id | bigint | Unique surrogate identifier for the grading period. |
canvas_id | bigint | Primary key for the grading period. |
grading_period_group_id | bigint | Surrogate ID to the grading period group table. |
close_date | timestamp | Grades can only be changed before the close date of the grading period. |
created_at | timestamp | Timestamp when record was created |
end_date | timestamp | End date of the grading period. |
start_date | timestamp | Start date of the grading period. |
title | varchar | Title for the grading period. |
updated_at | timestamp | Timestamp when record was last updated. |
workflow_state | varchar | current workflow state. Possible values are 'active', 'deleted' |
grading_period_group_dim
Attributes for grading period groups. Which are a group of grading periods.
Type: dimension
Columns
Name | Type | Description |
---|---|---|
id | bigint | Unique surrogate identifier for the grading period groups |
canvas_id | bigint | Primary key for the grading period groups |
course_id | bigint | Foreign key to the Course table. |
account_id | bigint | Foreign key to the Account table. |
created_at | timestamp | Timestamp when record was created. |
title | varchar | Title for the grading period group. |
updated_at | timestamp | Timestamp when record was last updated. |
workflow_state | varchar | Workflow state for the grading period group. Possible values are 'active', 'deleted' |
grading_period_score_dim
Attributes for Grading Period scores. You can think of a score as synonymous with a cell inside the grade book.
Type: dimension
Columns
Name | Type | Description |
---|---|---|
id | bigint | Unique surrogate identifier for the score. |
canvas_id | bigint | Primary key for the score. |
enrollment_id | bigint | Foreign key to the Enrollment table. |
grading_period_id | bigint | Foreign key to the grading period group table. |
created_at | timestamp | Timestamp when record was created. |
updated_at | timestamp | Timestamp when record was last updated. |
workflow_state | enum | Workflow state for the score. Possible values are 'active', 'deleted' |
group_dim
Attributes for groups in canvas. Groups contain two or more students enrolled in a particular course working on an assignment or project together.
Type: dimension
Columns
Name | Type | Description |
---|---|---|
id | bigint | Unique surrogate id for the group. |
canvas_id | bigint | Primary key to the groups table in canvas. |
name | varchar | Name of the group. |
description | text | Description of the group. |
created_at | timestamp | Timestamp when the group was first saved in the system. |
updated_at | timestamp | Timestamp when the group was last updated in the system. |
deleted_at | timestamp | Timestamp when the group was deleted. |
is_public | boolean | True if the group contents are accessible to public. |
workflow_state | varchar | Workflow state for group.(values: deleted,active) |
context_type | varchar | The context type to which the group belongs to. For example- Accounts, Courses etc. |
category | text | Group description by the users. |
join_level | varchar | Permissions required to join a group. For example, it can be invitation-only or auto. |
default_view | varchar | Default view for groups is the feed. |
sis_source_id | bigint | Correlated id for the record for this group in the SIS system (assuming SIS integration is configured) |
group_category_id | bigint | (Not implemented) Foreign key to group category dimension table. |
account_id | bigint | Parent account for this group. |
wiki_id | bigint | Foreign key to the wiki_dim table. |
group_membership_dim
Attributes for groups_membership in canvas.
Type: dimension
Columns
Name | Type | Description |
---|---|---|
id | varchar | The ID of the membership object |
canvas_id | varchar | The ID of the membership object as it appears in the db. |
group_id | bigint | Foreign key to the group dimension for a particular group. |
moderator | enum | Whether or not the user is a moderator of the group. Possible values are 'is_moderator' and 'not_moderator'. |
workflow_state | enum | The current state of the membership. Current possible values are 'accepted', 'invited', 'requested', and 'deleted' |
created_at | timestamp | Timestamp when the group membership was first saved in the system. |
updated_at | timestamp | Timestamp when the group membership was last updated in the system. |
learning_outcome_dim
Learning outcomes are measurable statements that express student knowledge or a student skill. This table contains dimensions for learning outcomes.
Type: dimension
Columns
Name | Type | Description |
---|---|---|
id | bigint | Unique surrogate id for the learning outcome. |
canvas_id | bigint | Primary key to the learning_outcomes table in canvas. |
account_id | bigint | Foreign key to the account associated with this outcome. |
course_id | bigint | Foreign key to the course associated with this outcome, if this outcome was created at the course level. |
short_description | varchar | Title of the outcome. |
description | text | Description of the outcome. |
workflow_state | varchar | Workflow status of the learning outcome. Possible values are 'active' and 'deleted'. Defaults to 'active'. |
created_at | timestamp | Time when the outcome was created. |
updated_at | timestamp | Time when the outcome was last updated. |
vendor_guid | varchar | A custom GUID for the learning standard. |
display_name | varchar | Optional friendly name for reporting. |
calculation_method | text | The method used to calculate student score. Possible values are "decaying_average", "highest", "latest" and "n_mastery". |
calculation_int | int | Defines the variable value used by the calculation_method. included only if calculation_method uses it. |
outcome_import_id | bigint | Foreign key to the outcome import associated with this outcome, if this outcome was imported. |
learning_outcome_group_dim
Learning outcome groups organize outcomes hierarchically within a context, such as an account, course or the global context. This table contains dimensions for learning outcome groups.
Type: dimension
Columns
Name | Type | Description |
---|---|---|
id | bigint | Unique surrogate id for the learning outcome group |
canvas_id | bigint | Primary key for this record in the canvas learning_outcome_groups table |
account_id | bigint | Foreign key to the account associated with this outcome group, if this outcome group was created at the account level. |
course_id | bigint | Foreign key to the course associated with this outcome group, if this outcome group was created at the course level. |
title | varchar | Title of the learning outcome group. |
parent_group_id | bigint | ID associated with the parent of this group. Refers to a learning_outcome_group record. |
root_group_id | bigint | ID associated with the root group in the group hierarchy. Refers to a learning_outcome_group record. |
workflow_state | varchar | Workflow status of the learning outcome. Possible values are 'active' and 'deleted'. Defaults to 'active'. |
description | text | Description of the learning outcome group. |
created_at | timestamp | Time when the group was created. |
updated_at | timestamp | Time when the group was last updated. |
vendor_guid | varchar | A custom GUID for the learning standard. |
outcome_import_id | bigint | Foreign key to the outcome import associated with this outcome group, if this group was imported. |
learning_outcome_question_result_dim
Attributes for the results of answered questions which have been associated with a learning outcome
Type: dimension
Columns
Name | Type | Description |
---|---|---|
id | bigint | Unique surrogate key for the question result |
learning_outcome_result_id | bigint | Foreign key to the learning outcome result |
learning_outcome_id | bigint | Foreign key to the learning outcome this record is associated with |
assessment_question_id | bigint | Foreign key to the assessment question this record is associated with (assessment_questions to be included in a future release) |
title | text | |
created_at | timestamp | Time when question was created |
updated_at | timestamp | Time when question was updated |
assessed_at | timestamp | Time when answer was assessed |
submitted_at | timestamp | Time when answer was submitted |
learning_outcome_result_dim
Learning outcome results are a student's mastery score on a given outcome. This table contains dimensions for learning outcome results.
Type: dimension
Columns
Name | Type | Description |
---|---|---|
id | bigint | Unique surrogate key for the learning outcome result |
canvas_id | bigint | Primary key for this record in the canvas learning_outcome_results table |
account_id | bigint | Foreign key to the account associated with this outcome result, if this outcome result was created at the account level. |
course_id | bigint | Foreign key to the course associated with this outcome result, if this outcome result was created at the course level. |
assignment_id | bigint | Foreign key to the assignment associated with this outcome result, if this result was associated with an assignment |
quiz_id | bigint | Foreign key to the quiz associated with this outcome result, if this result was associated with a quiz |
learning_outcome_id | bigint | Foreign key to the learning outcome this result is associated with |
user_id | bigint | ID of the student who made the submission. Foreign key to the user dimension table |
created_at | timestamp | Time when the result was created. |
updated_at | timestamp | Time when the result was last updated. |
assessed_at | timestamp | Time when the result was assessed. |
submitted_at | timestamp | Time when the submission was submitted. |
hide_points | boolean | Boolean indicating if outcome result points should be hidden in the Learning Mastery Gradebook and reports. If enabled, replace points with the description of the highest scoring outcome criterion rating. |
hidden | boolean | Boolean indicating if outcome result should be hidden from the Learning Mastery Gradebook and reports. |
learning_outcome_rubric_criterion_dim
Contains dimensions for criterion of a given outcome.
Type: dimension
Columns
Name | Type | Description |
---|---|---|
id | bigint | Unique surrogate id for the rubric criterion |
learning_outcome_id | bigint | Foreign key to the learning outcome dimension |
description | text | Description of the rubric criterion |
module_completion_requirement_dim
Attributes for a module completion.
Type: dimension
Columns
Name | Type | Description |
---|---|---|
id | bigint | Unique surrogate ID for the module completion requirement. |
module_id | bigint | Module that contains the completion requirement. |
module_item_id | bigint | Item that is the subject of the completion requirement. |
requirement_type | enum | Type of completion event that must be achieved to consider item complete. |
module_dim
Attributes for a module.
Type: dimension
Columns
Name | Type | Description |
---|---|---|
id | bigint | Unique surrogate ID for the module. |
canvas_id | bigint | Original primary key for module in the Canvas table. |
course_id | bigint | The course that owns this module. |
require_sequential_progress | enum | Should module items be completed sequentially? Valid values are 'required', 'not_required', 'unspecified'. |
workflow_state | enum | Workflow state for submission lifetime values. Possible values are 'locked', 'completed', 'unlocked' and 'started'. |
position | integer | Position of the module on the modules page. |
name | text | The name of the module in Canvas. |
created_at | timestamp | Date/Time when the module was created. |
deleted_at | timestamp | Timestamp when the module was deleted. |
unlock_at | timestamp | Timestamp when the module will unlock. |
updated_at | timestamp | Date/Time when the module was last updated. |
module_item_dim
Attributes for a module item.
Type: dimension
Columns
Name | Type | Description |
---|---|---|
id | bigint | Unique surrogate ID for the module_item. |
canvas_id | bigint | Original primary key for module_item in the Canvas table. |
assignment_id | bigint | Key into assignments table for 'Assignment' type items. |
course_id | bigint | The course that owns this module. |
discussion_topic_id | bigint | Key into discussion_topics table for 'Discussion' type items. |
file_id | bigint | Key into file table for 'File' type items. |
module_id | bigint | Parent module for this module item. |
quiz_id | bigint | Key into quizzes table for 'Quiz' type items. |
wiki_page_id | bigint | Key into wiki_pages table for 'Page' type items. |
content_type | enum | The type of content linked to this item. One of: 'Assignment', 'Attachment', 'DiscussionTopic', 'ContextExternalTool', 'ContextModuleSubHeader', 'ExternalUrl', 'LearningOutcome', 'Quiz', 'Rubric' or 'WikiPage'. |
workflow_state | enum | State of the module item. |
position | integer | Position of the module item within the module context. |
title | text | Title of the module item. |
url | text | Url for external url type module items. |
created_at | timestamp | Date/Time when the module item was created. |
updated_at | timestamp | Date/Time when the module item was last updated. |
module_prerequisite_dim
Attributes for a module prerequisite.
Type: dimension
Columns
Name | Type | Description |
---|---|---|
id | bigint | Unique surrogate ID for the module prerequisite. |
module_id | bigint | Module that contains the prerequisite. |
prerequisite_module_id | bigint | Module that must be completed to fulfill the prerequisite. |
module_progression_completion_requirement_dim
Attributes tracking a requirement that remains to be completed by a user. Not a comprehensive list, typically just holds requirements that have been attempted by the user.
Type: dimension
Columns
Name | Type | Description |
---|---|---|
id | bigint | Unique surrogate ID for the module progression completion requirement. |
module_progression_id | bigint | Module progression referenced by completion requirement. |
module_item_id | bigint | Item that the user has not completed. |
requirement_type | enum | Type of completion event that must be achieved to consider item complete. |
completion_status | enum | Denotes if the completion event is complete or not. Possible values are 'complete' and 'incomplete'. |
module_progression_dim
Attributes for a module progression.
Type: dimension
Columns
Name | Type | Description |
---|---|---|
id | bigint | Unique surrogate ID for the module progression. |
canvas_id | bigint | Original primary key for module progression in the Canvas table. |
module_id | bigint | Parent module for this module progression. |
user_id | bigint | User being tracked in the module progression. |
collapsed | enum | Collapsed state of the module progression. |
is_current | enum | The current state of the module progression. |
workflow_state | enum | The workflow state of the module progression. |
current_position | integer | Represents the users current position in the module. |
lock_version | integer | Lock version of the module progression. |
created_at | timestamp | Date/Time when the module progression was created. |
completed_at | timestamp | Date/Time when the module progression was completed. |
evaluated_at | timestamp | Date/Time when the module progression was evaluated. |
updated_at | timestamp | Date/Time when the module progression was last updated. |
pseudonym_dim
Pseudonyms are logins associated with users.
Type: dimension
Columns
Name | Type | Description |
---|---|---|
id | bigint | Unique surrogate id for the pseudonym. |
canvas_id | bigint | Primary key for this pseudonym in the the Canvas database |
user_id | bigint | Id for the user associated with this pseudonym |
account_id | bigint | Id for the account associated with this pseudonym |
workflow_state | varchar | Workflow status indicating that pseudonym is [deleted] or [active] |
last_request_at | timestamp | Timestamp of when the user last logged in with this pseudonym |
last_login_at | timestamp | Timestamp of last time a user logged in with this pseudonym |
current_login_at | timestamp | Timestamp of when the user logged in |
last_login_ip | varchar | IP address recorded the last time a user logged in with this pseudonym |
current_login_ip | varchar | IP address of user's current/last login |
position | int | Position of user's login credentials |
created_at | timestamp | Timestamp when this pseudonym was created in Canvas |
updated_at | timestamp | Timestamp when this pseudonym was last updated in Canvas |
password_auto_generated | boolean | True if the password has been auto-generated |
deleted_at | timestamp | Timestamp when the pseudonym was deleted (NULL if the pseudonym is still active) |
sis_user_id | varchar | Correlated id for the record for this course in the SIS system (assuming SIS integration is configured) |
unique_name | varchar | Actual login id for a given pseudonym/account |
integration_id | varchar | A secondary unique identifier useful for more complex SIS integrations. This identifier must not change for the user, and must be globally unique. |
authentication_provider_id | bigint | The authentication provider this login is associated with. This can be the integer ID of the provider, or the type of the provider (in which case, it will find the first matching provider.) |
quiz_dim
Attributes for quiz.
Type: dimension
Columns
Name | Type | Description |
---|---|---|
id | bigint | Unique surrogate ID for the quiz. |
canvas_id | bigint | Primary key for this quiz in the quizzes table. |
root_account_id | bigint | Root account ID associated with this quiz. |
name | varchar | Name of the quiz. Equivalent Canvas API field -> 'title'. |
points_possible | double precision | Total point value given to the quiz. |
description | text | Description of the quiz. |
quiz_type | varchar | Type of quiz. Possible values are 'practice_quiz', 'assignment', 'graded_survey' and 'survey'. Defaults to 'NULL'. |
course_id | bigint | Foreign key to the course the quiz belongs to. |
assignment_id | bigint | Foreign key to the assignment the quiz belongs to. |
workflow_state | varchar | Denotes where the quiz is in the workflow. Possible values are 'unpublished', 'published' and 'deleted'. Defaults to 'unpublished'. |
scoring_policy | varchar | Scoring policy for a quiz that students can take multiple times. Is required and only valid if allowed_attempts > 1. Possible values are 'keep_highest', 'keep_latest' and 'keep_average'. Defaults to 'keep_highest'. |
anonymous_submissions | varchar | Dictates whether students are allowed to submit the quiz anonymously. Possible values are 'allow_anonymous_submissions' and 'disallow_anonymous_submissions'. Defaults to 'disallow_anonymous_submissions'. |
display_questions | varchar | Policy for displaying the questions in the quiz. Possible values are 'multiple_at_a_time' and 'one_at_a_time'. Defaults to 'multiple_at_a_time'. Equivalent Canvas API field -> 'one_question_at_a_time'. |
answer_display_order | varchar | Policy for displaying the answers for each question in the quiz. Possible values are 'in_order' and 'shuffled'. Defaults to 'in_order'. Equivalent Canvas API field -> 'shuffle_answers'. |
go_back_to_previous_question | varchar | Policy on going back to the previous question. Is valid only if 'display_questions' is set to 'one_at_a_time'. Possible values are 'allow_going_back' and 'disallow_going_back'. Defaults to 'allow_going_back'. Equivalent Canvas API field -> 'cant_go_back'. |
could_be_locked | varchar | Dictates if the quiz can be locked or not. Possible values are 'allow_locking' and 'disallow_locking'. Defaults to 'disallow_locking'. |
browser_lockdown | varchar | Dictates whether the browser has locked-down when the quiz is being taken. Possible values are 'required' and 'not_required'. Defaults to 'not_required'. |
browser_lockdown_for_displaying_results | varchar | Dictates whether the browser has to be locked-down to display the results. Is valid only if 'hide_results' is set to 'never' or 'until_after_last_attempt' (for the results to be displayed after the last attempt). Possible values are 'required' and 'not_required'. Defaults to 'not_required'. |
browser_lockdown_monitor | varchar | Dictates whether a browser lockdown monitor is required. Possible values are 'required' and 'not_required'. Defaults to 'not_required'. |
ip_filter | varchar | Restricts access to the quiz to computers in a specified IP range. Filters can be a comma-separated list of addresses, or an address followed by a mask. |
show_results | varchar | Dictates whether or not quiz results are shown to students. If set to 'always', students can see their results after any attempt and if set to 'never', students can never see their results. If 'dw_quiz_fact.allowed_attempts > 1' then when set to 'always_after_last_attempt', students can only see their results always, but only after their last attempt. Similarly, if set to 'only_once_after_last_attempt', then students can see their results only after their last attempt, that too only once. Possible values are 'always', 'never', 'always_after_last_attempt' and 'only_once_after_last_attempt'. Defaults to 'always'. Equivalent Canvas API field -> 'hide_results' combined with 'one_time_results'. |
show_correct_answers | varchar | Dictates whether correct answers are shown when are results are viewed. It's valid only if 'show_results' is set to 'always'. Possible values are 'always', 'never', 'only_once_after_last_attempt' and 'always_after_last_attempt' (Last two are only valid if 'dw_quiz_fact.allowed_attempts > 1') which have a behavior similar to 'show_results'. Defaults to 'always'. Equivalent Canvas API field -> 'show_correct_answers' combined with 'show_correct_answers_last_attempt'. |
show_correct_answers_at | timestamp | Day/Time when the correct answers would be shown. |
hide_correct_answers_at | timestamp | Day/Time when the correct answers are to be hidden. |
created_at | timestamp | Time when the quiz was created. |
updated_at | timestamp | Time when the quiz was last updated. |
published_at | timestamp | Time when the quiz was published. |
unlock_at | timestamp | Day/Time when the quiz is to be unlocked for students. |
lock_at | timestamp | Day/Time when the quiz is to be locked for students. |
due_at | timestamp | Day/Time when the quiz is due. |
deleted_at | timestamp | Time when the quiz was deleted. |
quiz_question_answer_dim
Attributes of an answer related to a quiz question.
Type: dimension
Columns
Name | Type | Description |
---|---|---|
id | bigint | Unique surrogate key for the quiz question answer. As with all surrogate keys in Canvas Data, there is no guarantee of stability. That said, this key is particularly unstable and will likely change from dump to dump even if there are no data change. |
canvas_id | bigint | Primary key for this quiz question answer. No table available in Canvas. |
quiz_question_id | bigint | Foreign key to the quiz question dimension column. |
text | text | Text of the answer. |
html | text | HTML markup of the text. |
comments | text | Specific contextual comments for a particular answer. |
text_after_answers | text | (Used in 'short_answer_question', also known as 'fill_in_the_blank'. Set to 'NULL' in others) Text following the missing word. |
answer_match_left | varchar | (Used in 'matching_question', set to 'NULL' in others) Static value of the answer that will be displayed on the left for students to match for. |
answer_match_right | varchar | (Used in 'matching_question', set to 'NULL' in others) Correct match for the value given in 'answer_match_left', displayed in a drop-down with other 'answer_match_right' values. |
matching_answer_incorrect_matches | varchar | (Used in 'matching_question', set to 'NULL' in others) List of distractors (incorrect answers), delimited by new lines, that will be seeded with all the 'answer_match_right' values. |
numerical_answer_type | varchar | (Used in 'numerical_question', set to 'NULL' in others) Denotes the type of numerical answer that is expected. Possible values are 'exact_answer' and 'range_answer'. |
blank_id | varchar | (Used in 'fill_in_multiple_blanks_question' and 'multiple_dropdowns_question', set to 'NULL' otherwise) Refers to the ID of the blank(s) in the question text. |
exact | double precision | (Used in 'numerical_question' with answer type 'exact_answer', set to 'NULL' otherwise) Value the answer must be equal to. |
margin | double precision | (Used in 'numerical_question' with answer type 'exact_answer', set to 'NULL' otherwise) Margin of error allowed for a student's answer. |
starting_range | double precision | (Used in 'numerical_question' with answer type 'range_answer', set to 'NULL' otherwise) Start of the allowed range (inclusive). |
ending_range | double precision | (Used in 'numerical_question' with answer type 'range_answer', set to 'NULL' otherwise) End of the allowed range (inclusive). |
quiz_question_dim
Attributes of a question associated with a quiz.
Type: dimension
Columns
Name | Type | Description |
---|---|---|
id | bigint | Unique surrogate key for the quiz question. |
canvas_id | bigint | Primary key for this quiz question in the 'quiz_questions' table. |
quiz_id | bigint | Foreign key to the quiz dimension table. |
quiz_question_group_id | bigint | Foreign key to the quiz group dimension table. |
position | int | Order in which the question will be displayed in the quiz relative to other questions associated with the quiz. |
workflow_state | varchar | Denotes where the quiz question is in the workflow. Possible values are 'unpublished', 'published' and 'deleted'. Defaults to 'unpublished'. |
created_at | timestamp | Time when the quiz question was created. |
updated_at | timestamp | Time when the quiz question was last updated. |
assessment_question_id | bigint | Foreign key to the assessment question dimension table (to be made available in later releases). |
assessment_question_version | int | Version of the assessment question associated with the quiz question (to be made available in later releases). |
name | varchar | Name of the question. |
question_type | varchar | Denotes the type of the question. Possible values are 'calculated_question', 'essay_question', 'file_upload_question', 'fill_in_multiple_blanks_question', 'matching_question', 'multiple_answers_question', 'multiple_choice_question', 'multiple_dropdowns_question', 'numerical_question', 'short_answer_question', 'text_only_question' and 'true_false_question'. |
question_text | text | Text content of the question. |
regrade_option | varchar | Denotes if regrading is available for the question. Possible values are 'available' and 'unavailable' for question types 'multiple_answers_question', 'multiple_choice_question', 'true_false_question' and 'NULL' for others. Defaults to 'available' for the allowed question types and 'NULL' for the rest. |
correct_comments | text | Comments to be displayed if the student answers the question correctly. |
incorrect_comments | text | Comments to be displayed if the student answers the question incorrectly. |
neutral_comments | text | Comments to be displayed regardless of how the student answers the question. |
quiz_question_group_dim
Attributes for quiz group.
Type: dimension
Columns
Name | Type | Description |
---|---|---|
id | bigint | Unique surrogate ID for the quiz group. |
canvas_id | bigint | Primary key for this quiz group in the 'quiz_question_groups' table. |
quiz_id | bigint | Foreign key to quiz dimension. |
name | varchar | Name of the quiz group. |
position | int | Order in which the questions from this group will be displayed in the quiz relative to other questions in the quiz from other groups. |
created_at | timestamp | Time when the quiz question was created. |
updated_at | timestamp | Time when the quiz question was last updated. |
quiz_submission_dim
Attributes for the last submitted quiz
Type: dimension
Columns
Name | Type | Description |
---|---|---|
id | bigint | Unique surrogate ID for the quiz submission. |
canvas_id | bigint | Primary key for this quiz submission in the 'quiz_submissions' Canvas table. |
quiz_id | bigint | ID of the quiz the quiz submission represents. Foreign key to the quiz dimension table. |
submission_id | bigint | ID to the submission the quiz submission represents. Foreign key to the quiz submission dimension table. |
user_id | bigint | ID of the user (who is a student) who made the submission. Foreign key to the user dimension table. |
workflow_state | varchar | Denotes the current state of the quiz submission. Possible values are 'untaken', 'complete', 'pending_review', 'preview' and 'settings_only'. Defaults to 'untaken'. An 'untaken' quiz submission is recorded as soon as a student starts the quiz taking process, before even answering the first question. 'pending_review' denotes that a manual submission has been made by the student which has not been completely graded yet. This usually happens when one or more questions in the quiz cannot be autograded (e.g.. 'essay_question' type questions). A 'preview' workflow state is recorded when a Teacher or Admin previews a quiz (even a partial one). 'settings_only' pertains only to quiz moderation events. It stores the settings to create and store moderation events before the student has begun an attempt. |
quiz_state_during_submission | varchar | There can be two types of quiz states during submission, 1. Quiz submission took place after the quiz was manually unlocked after being locked (but only for a particular student such that (s)he can take the quiz even if it's locked for everyone else). 2. Quiz submission was on-time (that is, when the quiz was never locked). So the two possible values are 'manually_unlocked' and 'never_locked'. Defaults to 'never_locked'. |
submission_scoring_policy | varchar | Denotes if the score has been manually overridden by a teacher to reflect the score of a previous attempt (as opposed to a score calculated by the quiz's scoring policy. Possible values are 'manually_overridden' or the general quiz scoring policies, i.e. 'keep_highest', 'keep_latest' and 'keep_average'. Defaults to the scoring policy of the quiz the submission is associated with. |
submission_source | varchar | Denotes where the submission was received from. Possible values are 'student' and 'test_preview'. Defaults to 'student'. |
has_seen_results | varchar | Denotes whether the student has viewed their results to the quiz. |
temporary_user_code | varchar | Construct for previewing a quiz. |
created_at | timestamp | Time when the quiz submission was created. |
updated_at | timestamp | Time when the quiz submission was last updated. |
started_at | timestamp | Time at which the student started the quiz submission. |
finished_at | timestamp | Time at which the student submitted the quiz submission. |
due_at | timestamp | Time at which the quiz submission will be overdue, and will be flagged as a late submission. |
quiz_submission_historical_dim
Attributes for all submitted quizzes
Type: dimension
Columns
Name | Type | Description |
---|---|---|
id | bigint | Unique surrogate ID for the quiz submission. |
canvas_id | bigint | Primary key for this quiz submission in the 'quiz_submissions' Canvas table. |
quiz_id | bigint | ID of the quiz the quiz submission represents. Foreign key to the quiz dimension table. |
submission_id | bigint | ID to the submission the quiz submission represents. Foreign key to the quiz submission dimension table. |
user_id | bigint | ID of the user (who is a student) who made the submission. Foreign key to the user dimension table. |
version_number | int | Version number of this quiz submission. |
submission_state | varchar | Denotes if the quiz submission is a current or previous submission. Possible values are 'current_submission' and 'previous_submission'. Defaults to 'current_submission'. |
workflow_state | varchar | Denotes the current state of the quiz submission. Possible values are 'untaken', 'complete', 'pending_review', 'preview' and 'settings_only'. Out of these, 'settings_only' pertains only to quiz moderation events. It stores the settings to create and store moderation events before the student has begun an attempt. Defaults to 'untaken'. |
quiz_state_during_submission | varchar | There can be two types of quiz states during submission, 1. Quiz submission took place after the quiz was manually unlocked after being locked (but only for a particular student such that (s)he can take the quiz even if it's locked for everyone else). 2. Quiz submission was on-time (that is, when the quiz was never locked). So the two possible values are 'manually_unlocked' and 'never_locked'. Defaults to 'never_locked'. |
submission_scoring_policy | varchar | Denotes if the score has been manually overridden by a teacher to reflect the score of a previous attempt (as opposed to a score calculated by the quiz's scoring policy. Possible values are 'manually_overridden' or the general quiz scoring policies, i.e. 'keep_highest', 'keep_latest' and 'keep_average'. Defaults to the scoring policy of the quiz the submission is associated with. |
submission_source | varchar | Denotes where the submission was received from. Possible values are 'student' and 'test_preview'. Defaults to 'student'. |
has_seen_results | varchar | Denotes whether the student has viewed their results to the quiz. |
temporary_user_code | varchar | Construct for previewing a quiz. |
created_at | timestamp | Time when the quiz submission was created. |
updated_at | timestamp | Time when the quiz submission was last updated. |
started_at | timestamp | Time at which the student started the quiz submission. |
finished_at | timestamp | Time at which the student submitted the quiz submission. |
due_at | timestamp | Time at which the quiz submission will be overdue, and will be flagged as a late submission. |
role_dim
Give the possible roles for an enrolled user
Type: dimension
Columns
Name | Type | Description |
---|---|---|
id | bigint | Unique surrogate id for the role. |
canvas_id | bigint | Primary key for this record in the Canvas roles table |
root_account_id | bigint | Foreign key to the account dimension for this role's root account. |
account_id | bigint | The foreign key to the account that is in the role |
name | varchar | The name of role, previously was "role_name" on the enrollments_dim |
base_role_type | varchar | The built in type this role is based on. |
workflow_state | varchar | Workflow status indicating that the role is [deleted] or [inactive] |
created_at | timestamp | Timestamp of the first time the role was entered into the system |
updated_at | timestamp | Timestamp of the last time the role was updated |
deleted_at | timestamp | Timestamp of when the role was removed from the system |
submission_comment_dim
Table contains attributes related to the submission comments feature in Canvas.
Type: dimension
Columns
Name | Type | Description |
---|---|---|
id | bigint | |
canvas_id | bigint | |
submission_id | bigint | |
recipient_id | bigint | [Deprecated] No longer used in Canvas, will always be NULL. |
author_id | bigint | |
assessment_request_id | bigint | |
group_comment_id | varchar | |
comment | text | |
author_name | varchar | |
created_at | timestamp | |
updated_at | timestamp | |
anonymous | boolean | |
teacher_only_comment | boolean | |
hidden | boolean |
submission_dim
This table records the latest submission for an assignment.
Type: dimension
Columns
Name | Type | Description |
---|---|---|
id | bigint | Unique surrogate ID for the submission. |
canvas_id | bigint | Primary key of this record in the Canvas submissions table. |
body | text | Text content for the submission. |
url | varchar | URL content for the submission. |
grade | varchar | Letter grade mapped from the score by the grading scheme. |
submitted_at | timestamp | Timestamp of when the submission was submitted. |
submission_type | enum | Type of submission. Possible values are 'discussion_topic', 'external_tool', 'media_recording', 'online_file_upload', 'online_quiz', 'online_text_entry', 'online_upload' and 'online_url'. |
workflow_state | enum | Workflow state for submission lifetime values. Possible values are 'graded', 'pending_review', 'submitted' and 'unsubmitted'. |
created_at | timestamp | Timestamp of when the submission was created. |
updated_at | timestamp | Timestamp of when the submission was last updated. |
processed | boolean | Valid only when there is a file/attachment associated with the submission. By default, this attribute is set to 'false' when making the assignment submission. When a submission has a file/attachment associated with it, upon submitting the assignment a snapshot is saved and its' value is set to 'true'. Defaults to 'NULL'. |
process_attempts | int | [Deprecated] No longer used in Canvas, will always be NULL. |
grade_matches_current_submission | boolean | Valid only when a score has been assigned to a submission. This is set to 'false' if a student makes a new submission to an already graded assignment. This is done to indicate that the current grade given by the teacher is not for the most recent submission by the student. It is set to 'true' if a score has been given and there is no new submission. Defaults to 'NULL'. |
published_grade | varchar | Valid only for a graded submission. The values are strings that reflect the grading type used. For example, a scoring method of 'points' will show '4' if given a '4' out of '5', and a scoring method of 'letter grade' will show 'B' for the same score (assuming a grading scale where 80-90% is a 'B'). Defaults to 'NULL'. |
graded_at | timestamp | Timestamp of when the submission was graded. |
has_rubric_assessment | boolean | [Deprecated] No longer used in Canvas, will always be NULL. |
attempt | int | The number of attempts made including this one. |
has_admin_comment | boolean | [Deprecated] No longer used in Canvas, will always be NULL. |
assignment_id | bigint | Foreign key to assignment dimension. |
excused | enum | Denotes if this submission is excused or not. Possible values are 'excused_submission' and 'regular_submission'. |
graded_anonymously | enum | Denotes how the grading has been performed. Possible values are 'graded_anonymously' and 'not_graded_anonymously'. |
grader_id | bigint | Foreign key to the user dimension of user who graded the assignment. |
group_id | bigint | Foreign key to the group_dim table. |
quiz_submission_id | bigint | Foreign key to the quiz_submission_dim table. |
user_id | bigint | Foreign key to the user_dim table. |
grade_state | enum | Denotes the current state of the grade. Possible values are 'auto_graded', 'human_graded' and 'not_graded'. |
posted_at | timestamp | The date this submission was posted to the student, or null if it has not been posted. |
user_dim
Attributes for users
Type: dimension
Columns
Name | Type | Description |
---|---|---|
id | bigint | Unique surrogate id for the user. This ID is obfuscated to protect the identity of the user. |
canvas_id | bigint | Primary key for this user in the Canvas users table. |
root_account_id | bigint | Root account associated with this user. |
name | varchar | Name of the user |
time_zone | varchar | User's primary timezone |
created_at | timestamp | Timestamp when the user was created in the Canvas system |
visibility | varchar | [Deprecated] No longer used in Canvas, will always be NULL. |
school_name | varchar | Used in Trial Versions of Canvas, the school the user is associated with |
school_position | varchar | Used in Trial Versions of Canvas, the position the user has at the school. E.g. Admin |
gender | varchar | The user's gender. This is an optional field and may not be entered by the user. |
locale | varchar | The user's locale. This is an optional field and may not be entered by the user. |
public | varchar | Used in Trial Versions of Canvas, the type of school the user is associated with |
birthdate | timestamp | The user's birth date. This is an optional field and may not be entered by the user. |
country_code | varchar | The user's country code. This is an optional field and may not be entered by the user. |
workflow_state | varchar | Workflow status indicating the status of the user, valid values are: creation_pending, deleted, pre_registered, registered |
sortable_name | varchar | Name of the user that is should be used for sorting groups of users, such as in the gradebook. |
global_canvas_id | varchar | Similar to canvas_id but globalized. This field uses the same globalization as the 'id' field of all other canvas-data tables. Use this field to join to caliper or live event streams. |
wiki_dim
Attributes for wiki in canvas.
Type: dimension
Columns
Name | Type | Description |
---|---|---|
id | bigint | Unique id for the wiki. |
canvas_id | bigint | Primary key to the wikis table in canvas. |
parent_type | varchar | Type of Parent the wiki belongs to. For example, Groups or Courses. |
title | text | Title for the wiki. |
created_at | timestamp | Timestamp when the wiki was first saved in the system. |
updated_at | timestamp | Timestamp when the wiki was last updated in the system. |
front_page_url | text | URL of the front page of the wiki. |
has_no_front_page | boolean | True if the wiki does not have a front page or is set to NULL. |
wiki_page_dim
Attributes for wiki pages in canvas.
Type: dimension
Columns
Name | Type | Description |
---|---|---|
id | bigint | Unique id for the wiki pages. |
canvas_id | bigint | Primary key for the wiki pages table. |
title | varchar | Title of the wiki page. |
body | text | Body of the wiki page. Redshift will only load the first 256 bytes of the body. |
workflow_state | varchar | Current state the wiki is in. For Example, active, unpublished, deleted. |
created_at | timestamp | Timestamp when the wiki page was created in the system. |
updated_at | timestamp | Timestamp when the wiki page was last updated in the system. |
url | text | URL for the wiki page. |
protected_editing | boolean | Editing protection for the wiki page. It is false by default. |
editing_roles | varchar | Users or roles who can edit a wiki page. |
revised_at | timestamp | Timestamp the wiki page was last revised in the system. |
could_be_locked | boolean | True if the wiki page can be locked. This prevents it from being visible to others until ready. |
requests
Canvas application server request logs. Disclaimer: The data in the requests table is a 'best effort' attempt, and is not guaranteed to be complete or wholly accurate. This data is meant to be used for rollups and analysis in the aggregate, _not_ in isolation for auditing or other high-stakes analysis involving examining single users or small samples. As this data is generated from the Canvas request log files, not a transactional database, there are many places along the way data can be lost and/or duplicated (though uncommon).
Type: both
Columns
Name | Type | Description |
---|---|---|
id | guid | Request ID assigned by the canvas system to the request. |
timestamp | datetime | Timestamp when the request was made in UTC. |
timestamp_year | varchar | Year when the request was made. |
timestamp_month | varchar | Month when the request was made. |
timestamp_day | varchar | Day when the request was made. |
user_id | bigint | Foreign key in user_dim for the user that made the request. If the request was made by one user masquerading as another, then this column contains the ID of the user being masqueraded as. |
course_id | bigint | Foreign key in course_dim for the course that owned the request. Set to NULL if not applicable. |
root_account_id | bigint | Foreign key in account_dim for the root account on which this request was made. |
course_account_id | bigint | Foreign key in account_dim for the account the associated course is owned by. |
quiz_id | bigint | Foreign key in quiz_dim if the request is for a quiz, otherwise NULL. |
discussion_id | bigint | Foreign key in discussion_dim if the request is for a discussion, otherwise NULL. |
conversation_id | bigint | Foreign key in conversation_dim if the request is for a conversation, otherwise NULL. |
assignment_id | bigint | Assignment foreign key if the request is for an assignment, otherwise NULL. |
url | text | URL which was requested. |
user_agent | text | User agent header received from the users browser/client software. |
http_method | varchar | HTTP method/verb (GET, PUT, POST etc.) that was sent with the request. |
remote_ip | varchar | IP address that was recorded from the request. |
interaction_micros | bigint | Total time required to service the request in microseconds. |
web_application_controller | varchar | The controller the Canvas web application used to service this request. |
web_application_action | varchar | Controller the Canvas web application used to service this request. |
web_application_context_type | varchar | Containing object type the Canvas web application used to service this request. |
web_application_context_id | varchar | Containing object's ID the Canvas web application used to service this request. |
real_user_id | bigint | If the request was processed by one user masquerading as another, then this column contains the real user ID of the user. |
session_id | varchar | ID of the user's session where this request was made. |
user_agent_id | bigint | (Not implemented) Foreign key to the user agent dimension table. |
http_status | varchar | HTTP status of the request. |
http_version | varchar | HTTP protocol version. |
developer_key_id | bigint | ID of the developer who accessed this resource if the request was made by a developer. |