Brightspace Data Sets for Discussions

Brightspace Data Sets for Discussions include:

These data sets have a dependency on Discussions. 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 Discussions, click the following thumbnail image:

Discussion Entity Relationship Diagram

Brightspace Data Set: Discussion Posts

About

Returns discussion posts posted in the past three calendar years. Results are ordered from newest to oldest. The Discussion Posts 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.

Note: You can extract the body of the discussion post through the API.

Returned Fields

Version History

Field

Description

Type

Column Size

Key

1.0

OrgUnitId

Unique org unit identifier

int

4

FK

2.5 / 3.0 - Added FK

TopicId

Unique topic identifier

bigint

8

FK

1.0

UserId

Unique user identifier

int

4

FK

1.0

PostId

Unique post identifier

bigint

8

PK

1.0

ThreadId

Unique thread identifier

bigint

8

 

1.0

IsReply

If post is a reply

bit

1

 

1.0

ParentPostId

Parent post Id.

Field can be null.

bigint

8

FK

1.0

NumReplies

Number of replies to a post

int

4

 

1.0

DatePosted

Date the post was made (UTC).

datetime2

8

 

1.0

IsDeleted

Is post deleted

bit

1

 

1.0

RatingSum

Sum of all ratings for a post

bigint

8

 

1.0

NumRatings

Number of ratings for a post

bigint

8

 

4.8 / 5.2 - Updated column size

Score

Users score on the post (if graded).

Field can be null.

decimal

19, 9

 

2.2 LastEditDate

Indicates the date when the discussion post was edited (UTC).

Field can be null.

datetime2 8  
2.2 SortOrder Display sort order used for the content objects int 4  
2.5 / 3.0 Depth Indicates the number of nested hierarchical levels in the discussion post. int 4  
3.7 / 4.2 Thread

Discussion thread name.

Field can be null.

nvarchar 400  
5.6 WordCount

Indicates the number of words counted in the discussion post.

Field can be null.

int 4  
5.6 AttachmentCount

Indicates the number of attachments associated with a discussion post.

Field can be null.

int 4  

 

Brightspace Data Set: Discussion Posts Read Status

About

Returns details on discussion posts read by users for your org units. The Discussion Post Read Status 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

TopicId

Unique topic identifier

bigint

8

FK

1.0

UserId

Unique user identifier

int

4

PK, FK

1.0

PostId

Unique post identifier

bigint

8

PK, FK

1.0

IsRead

If post has been read

bit

1

 

1.0

FirstReadDate

First time the post was read (UTC).

Field can be null.

datetime2

8

 

1.0

LastReadDate

Latest date when post was read (UTC).

Field can be null.

datetime2

8

 

6.7 Version Indicates the version of the row. This information is used to determine which table row occurred first, similar to the way time stamps function in other data sets. bigint 8  

 

Brightspace Data Set: Discussion Topic User Scores

About

Returns the scores a user received for a discussion topic.

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

UserId

Unique user identifier

int

4

PK, FK

1.0

TopicId

Unique topic identifier

bigint

8

PK,

FK

4.8 / 5.2 - Updated column size

Score

Topic score.

Field can be null.

decimal

19, 9

 

1.0

IsGraded

If topic was graded

bit

1

 

4.6 / 5.0 Version Indicates the version of the row. This information is used to determine which table row occurred first, similar to the way time stamps function in other data sets. bigint 8  

 

Brightspace Data Set: Discussion Forums

About

Returns discussion forums. Results are ordered from newest to oldest.

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

2.3

OrgUnitId

Unique org unit identifier.

int

4

FK

2.3

ForumId

Unique forum identifier.

bigint

8

PK
5.7 / 6.0 - Changed Column Size Name Name of the discussion topic. nvarchar 400  
2.4 - Updated Description

Description of the discussion forum.

Field can be null.

nvarchar 1000  
7.0 - Removed VisibleStartDate

First date when the discussion forum is visible to learners (UTC).

Field can be null.

datetime2 8  
7.0 - Removed VisibleEndDate

Last date when the discussion forum is visible to learners (UTC).

Field can be null.

datetime2 8  
7.0 - Removed PostingStartDate

First date when learners can post to the discussion forum (UTC).

Field can be null.

datetime2 8  
7.0 - Removed PostingEndDate

Last date when learners can post to the discussion forum (UTC).

Field can be null.

datetime2 8  
2.3 MustPostToParticipate Indicates that a user must post in the discussion forum in order to participate in any discussion threads. bit

1

 
2.3 AllowAnon Indicates whether there is anonymous posting permitted for the discussion forum. bit

1

 
2.3 IsHidden Indicates whether the discussion forum is hidden. bit

1

 
2.3 RequiresApproval Indicates that the discussion forum requires approval from a moderator before contributions to the forum are posted. bit

1

 
2.3 SortOrder Display sort order used for the content objects int 4  
2.3

IsDeleted

Indicates if the discussion topic is deleted.

Field can be null.

bit

1

 

2.3

DeletedDate

Date when the discussion forum was deleted (UTC).

Field can be null

datetime2

8

 

2.3

DeletedByUserId

User who deleted the discussion forum.

Field can be null.

int

4

FK

4.9 / 5.3 ResultId

Unique release condition result identifier.

Field can be null.

int 4 FK
6.12 / 7.0 - Added StartDate

First date when learners can post to topics in the forum (UTC).

Field can be null.

datetime2 8  
6.12 / 7.0 - Added StartDateAvailabilityType Before the StartDate, this type determines whether learners can view or access discussion topics within the forum. smallint 2  
6.12 / 7.0 - Added EndDate Last date when learners can post to topics in the forum (UTC). datetime2 8  
6.12 / 7.0 - Added EndDateAvailabilityType After the EndDate, this type determines whether learners can view or access discussion topics within the forum. smallint 2  

 

Brightspace Data Set: Discussion Topics

About

Returns discussion topics. Results are ordered from newest to oldest.

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

2.3

OrgUnitId

Unique org unit identifier.

int

4

FK

2.3

TopicId

Unique topic identifier.

bigint

8

PK
2.3 ForumId Unique discussion forum identifier.

bigint

8

FK
2.4 Name Name of the discussion topic. nvarchar 1000  
2.4 Description

Description of the discussion topic.

Field can be null.

nvarchar 1000  
7.0 - Removed VisibleStartDate

First date when the discussion topic is visible to learners (UTC).

Field can be null.

datetime2 8  
7.0 - Removed VisibleEndDate

Last date when the discussion topic is visible to learners (UTC).

Field can be null.

datetime2 8  
7.0 - Removed PostingStartDate

First date when learners can post to the discussion topic (UTC).

Field can be null.

datetime2 8  
7.0 - Removed PostingEndDate

Last date when learners can post to the discussion topic (UTC).

Field can be null.

datetime2 8  
2.3 MustPostToParticipate Indicates that a user must post in the discussion topic in order to participate in any discussion threads. bit

1

 
2.3 AllowAnon Indicates whether there is anonymous posting permitted for the discussion topic. bit

1

 
2.3 IsHidden Indicates whether the discussion topic is hidden. bit

1

 
2.3 RequiresApproval Indicates that the discussion topic requires approval from a moderator before contributions to the forum are posted. bit

1

 
2.3 LastPostDate

Indicates the last time a post was made to the discussion topic (UTC).

Field can be null.

datetime2 8  
2.3 LastPostUserId

Indicates the last user who made a post to the discussion topic.

Field can be null.

bigint 8  
2.3

NumViews

Indicates the number of views on the discussion topic.

bigint

8

 

2.3 SortOrder Display sort order used for the content objects. int 4  
2.3

IsDeleted

Indicates if the discussion topic is deleted.

Field can be null.

bit

1

 

2.3

DeletedDate

Date when the discussion topic was deleted (UTC).

Field can be null.

datetime2

8

 

2.3

DeletedByUserId

User who deleted the discussion topic.

Field can be null.

int

4

FK

3.8 / 4.3 GradeItemId

Unique grade identifier.

Field can be null.

int 4 FK
5.7 / 6.0 - Changed Column Size ScoreOutOf

Topic score used to evaluate the discussion thread.

Field can be null.

Note: Score can exceed ScoreOutOf.

float 53  
3.8 / 4.3 ScoreCalculationMethod Method used to calculate score. Strings are predefined, with the following values:
Average - Calculates the score from the average score of each post in the topic made by a user.
Max - Calculates the score based on the maximum score of any one post in the topic for a user.
Min - Calculates the score based on the minimum score of any one post in the topic for a user.
Mode Max - Given the number of posts, selects the score that is repeated the most. If there is a tie, it takes the highest score.
Mode Min - Given the number of posts, selects the score that is repeated the most. If there is a tie, it takes the lowest score.
Sum - Calculates the score from the sum of scores on each post in a topic for a user.
Blank value (null) - The score is not calculated based on the scores of each post (Manual updates).
varchar 19  
3.8 / 4.3 IncludeNonScoredValues Indicates whether to include non-scored values. True posts that have not been scored are scored as 0. Otherwise, posts without a score are not included in the score aggregate (defined in the ScoreCalculationType). bit 1  
3.8 / 4.3 Version Indicates the version of the row. This information is used to determine which table row occurred first, similar to the way time stamps function in other data sets. bigint 8  
4.9 / 5.3 ResultId

Unique release condition result identifier.

Field can be null.

int 4 FK
6.12 / 7.0 - Added StartDate

First date when learners can post to the topic (UTC).

Field can be null.

datetime2 8  
6.12 / 7.0 - Added StartDateAvailabilityType Before the StartDate, this type determines whether learners can view or access the discussion topic. smallint 2  
6.12 / 7.0 - Added EndDate

Last date when learners can post to the topic (UTC).

Field can be null.

datetime2 8  
6.12 / 7.0 - Added EndDateAvailabilityType After the EndDate, this type determines whether learners can view or access the discussion topic. smallint 2