Canvas Data Release Notes (2019-03-29)
In this Canvas Data release, the schema version has been updated to 4.2.3. Several new tables with Canvas Catalog data have been added.
Canvas Data is a service that provides institutions with optimized access to all their data for reporting and queries. Learn more about Canvas Data.
- Added Tables
- catalog_order_dim
- catalog_order_fact
- catalog_order_item_dim
- catalog_order_item_fact
- catalog_application_dim
- catalog_payment_dim
- catalog_payment_fact
- catalog_promotion_dim
- catalog_promotion_fact
- catalog_tag_dim
- catalog_product_tag_dim
Added Tables |
catalog_order_dim
Attributes for Catalog orders.
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, 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_fact
Measure for Catalog orders.
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_dim
Attributes for Catalog order items.
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_order_item_fact
Measures for catalog order items.
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_application_dim
Attributes for catalog applicants.
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_payment_dim
Attributes for catalog payments.
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_payment_fact
Measures for catalog payments.
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_promotion_dim
Attributes for Catalog promotions.
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 payment was updated |
catalog_promotion_fact
Measures for catalog promotions.
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 |
catalog_tag_dim
Attributes for Catalog tags.
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_product_tag_dim
Attributes for Catalog product tags.
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 |