Brightspace Data Sets for Content

Brightspace Data Sets for Content include:

These data sets have a dependency on Content. If you turn this tool on and off during the data set query period, there may be unexpected or missing content in your data sets.

Entity Relationship Diagram

To show the relationships between entities used to create Brightspace Data Sets for Content, click the following thumbnail image:

Entity Relationship Diagram for Content

 

Brightspace Data Set: Content Objects

About

Returns information about content topics and modules created for your org units.

Data Set Availability

This data set is available as:

  • Full CSV, produced on a weekly basis, containing all of the data.
  • Differential CSV, produced on a daily basis or hourly basis as a paid add-on, containing the differences (diffs) of the data that was updated or inserted since the last successful differential which is typically the previous day or hour, respectively.

Returned Fields

Version History

Field

Description

Type

Column Size

Key

1.0

ContentObjectId

Unique identifier of the content

Integer

4

PK

1.0

OrgUnitId

Unique org unit identifier

Integer

4

FK

1.0

Title

Content title

nvarchar

300

 

1.0

ContentObjectType

Content object type

String

6

 

1.0

CompletionType

Content completion type

String

20

 

1.0

ParentContentObjectId

Parent content object identifier

Integer

4

 

1.0

Location

Location of the content asset. Field can be null.

nvarchar

2048

 

1.0

StartDate

Content availability start date (UTC). Field can be null.

DateTime

8

 

1.0

EndDate

Content availability end date (UTC). Field can be null.

DateTime

8

 

1.0

DueDate

Content availability due date (UTC). Field can be null.

DateTime

8

 

1.0

ObjectId1

Object ID, depending on the type of associated tool: TopicId, ChecklistId, SurveyId, QuizId, DropboxId, ChatId, Self-AssessmentId. Field can be null.

Integer

4

 

1.0

ObjectId2

Object ID, depending on the type of associated tool: TopicId, ChecklistId, SurveyId, QuizId, DropboxId, ChatId, Self-AssessmentId. Field can be null.

Integer

4

 

1.0

ObjectId3

Object Id, depending on the type of associated tool: TopicId, ChecklistId, SurveyId, QuizId, DropboxId, ChatId, Self-AssessmentId. Field can be null.

Integer

4

 

5.0 – Updated name

LastModified Date the content was last modified (UTC). DateTime 8  
1.0

IsDeleted

Content is deleted

Boolean

1

 

2.2 - Added SortOrder Display sort order used for the content objects Integer 4  
3.0 / 2.5 - Added Depth Indicates the number of nested hierarchical levels in the discussion post. Integer 4  
4.6 / 5.0 - Added ToolId Unique identifier for the tool Integer 4 FK
4.6 / 5.0 - Added IsHidden Content object has not been published yet Boolean 1  

4.7 / 5.1 - Updated description

ResultId Release Condition unique result identifier. Can be null. Integer 4  
4.6 / 5.0 - Added CreatedBy User who created the content object. Field can be null Integer 4  
4.6 / 5.0 - Added LastModifiedBy User who last modified the content object. Field can be null Integer 4  
4.6 / 5.0 - Added DeletedDate Date when the content object was deleted. (UTC). Field can be null DateTime 8  
4.6 / 5.0 – Added DeletedBy User who deleted the discussion forum. Field can be null Integer 4  

 

Brightspace Data Set: Content User Completion

About

Returns information about specific user's completion of content topics.

Data Set Availability

This data set is available as:

  • Full CSV, produced on a weekly basis, containing all of the data.
  • Differential CSV, produced on a daily basis or hourly basis as a paid add-on, containing the differences (diffs) of the data that was updated or inserted since the last successful differential which is typically the previous day or hour, respectively.

Returned Fields

Version History

Field

Description

Type

Column Size

Key

1.0

ContentObjectId

Unique identifier of the content

Integer

4

PK

FK

1.0

OrgUnitId

Unique org unit identifier

Integer

4

FK

1.0

UserId

Unique user identifier

Integer

4

PK

FK

1.0

DateCompleted

Date content was completed (UTC). Field can be null.

DateTime

8

 

 

Brightspace Data Set: Content User Progress

About

Returns user progress records modified in the past three calendar years. Results are ordered from newest to oldest. The Content User Progress data set is limited to 3 years of data (all of the previous two calendar years and the current calendar year to date).

Data Set Availability

This data set is available as:

  • Full CSV, produced on a weekly basis, containing all of the data.
  • Differential CSV, produced on a daily basis or hourly basis as a paid add-on, containing the differences (diffs) of the data that was updated or inserted since the last successful differential which is typically the previous day or hour, respectively.

Returned Fields

Version History

Field

Description

Type

Column Size

Key

1.0

ContentObjectId

Unique identifier of the content

Integer

4

PK

FK

2.5/3.0 - Added FK

UserId

Unique user identifier

Integer

4

PK, FK

3.2 - Updated to indicate not in use.

CompletedDate

This column is currently not in use and appears as NULL.

DateTime

8

 

1.0

LastVisited

Date content was last visited (UTC). Field can be null.

DateTime

8

 

1.0

IsRead

Is content read by user

Boolean

1

 

2.4 - Updated definition

NumRealVisits

Number of visits where the content is viewed, and the user continues in Brightspace. Recommend adding Real and Fake visits for total visits by a user.

Integer

4

 

2.4 - Updated definition

NumFakeVisits

Number of visits where the content is viewed and the user leaves by closing the browser/tab or the session times out while the content is open.

Integer

4

 

3.0/2.5 - Updated definition

TotalTime

Total real visit time spent in content, in seconds

BigInteger

8

 

1.0

IsVisited

Is content visited by user

Boolean

1

 

1.0

IsCurrentBookmark

Is content bookmarked

Boolean

1

 

1.0

IsSelfAssessComplete

Is self assessment topic completed

Boolean

1

 

3.0/2.5 LastModified Indicates the last time the user progress record was changed.

DateTime

8