Skip to main content
Skip table of contents

Portal Sessions

This topic lists Data Explorer and API fields (and their descriptions) associated with sessions on the TAO Portal. The fields described in this topic are considered to be the most meaningful when performing a query of this data - not all fields returned with a query are listed.

Identification

Data Explorer

API

Description

Battery Id

batteryId

The Identifier of the battery assigned to the session.

Session Id

sessionId

The Identifier of the session.

Delivery Id

deliveryId

The delivery ID of the test.

Group Id

groupId

The Identifier of the group assigned to the session.

Session Name

sessionName

The name of the session.

Session Description

sessionDescription

The description of the session.

Group Name

groupName

The name of the group assigned to the session.

Group Description

groupDescription

The description of the group assigned to the session.

Delivery Name

deliveryName

The name of the delivery assigned to the session.

Tenant Id

tenantId

The unique identifier for the TAO environment on which the delivery was executed. 

Hierarchy Path

hierarchyPath

The values provided in this field will vary depending on your organization’s structure.

In an API query, the value will display as each level being listed consecutively, with each level’s name: For example:

CODE
hierarchyPath: 
{ Level 1: root name
Level 2: School name
Level 3: Class name
}

In Data Explorer, you can filter according to level.

Hierarchy Levels

hierarchyLevels

The level/organizational unit the assigned group is in.

This value will generally include the organizationId from the organizational unit.

Session configuration

Data Explorer

API

Description

Test Runner Review Settings.enabled

CODE
testRunnerReviewSettings {
enabled: 
}

Review settings are enabled for the session. For more information, see Creating a session.

Test Runner Review Settings.showScore

CODE
testRunnerReviewSettings {
showScore: 
}

The “show score” review setting is enabled for the session. For more information, see Creating a session.

Test Runner Review Settings.showCorrect

CODE
testRunnerReviewSettings {
showCorrect: 
}

The “show correct” (display correct answer) review setting is enabled for the session. For more information, see Creating a session.

Test Runner Security Plugins.preventScreenshot

CODE
testRunnerSecurityPlugins: {
preventScreenshot:
}

The security setting to prevent screenshots is enabled/disabled. For more information, see Creating a session.

Test Runner Security Plugins.preventRightClickAndKeyboardShortcuts

CODE
testRunnerSecurityPlugins: {
preventRightClickAndKeyboardShortcuts:
}

The security setting to prevent keyboard shortcuts is enabled/disabled. For more information, see Creating a session.

Test Runner Security Plugins.requireAuthorizationToStart

CODE
testRunnerSecurityPlugins: {
requireAuthorizationToStart:
}

The security setting requiring proctor authorization (for test takers to begin) is enabled/disabled. For more information, see Creating a session.

Test Runner Security Plugins.pauseTestWhenExitsFullScreen

CODE
testRunnerSecurityPlugins: {
pauseTestWhenExistFullScreen:
}

The security setting to pause the assessment if a test taker exits fullscreen mode is enabled/disabled. For more information, see Creating a session.

Test Runner Security Plugins.requireFullscreen

CODE
testRunnerSecurityPlugins: {
requireFullscreen:
}

The security setting to require fullscreen mode is enabled/disabled. For more information, see Creating a session.

Report Settings.studentReport

CODE
reportSettings: {
studentReport:
}

The session configuration to allow test takers to access their report (following completing the assessment) is enabled/disabled. For more information, see Creating a session.

Scoring

Data Explorer

API

Description

Grades Notification Start Date

The start date that test takers are notified of their grade (if enabled). For more information, see Creating a session.

Grades Notification Status

Grading Required

gradingRequired

The session contains items that require manual (human) scoring.

Delivery Grading Status

deliveryGradingStatus

The status of manual scoring.

Timestamps

Data Explorer

API

Description

Start Date

startDate

The start date of the session (provided as a unix timestamp).

End Date

endDate

The end date of the session (provided as a unix timestamp).

Timezone

timezone

The timezone the session was administered in.

Last_update_date

last_update_date

When the session was last updated (provided as a unix timestamp).

Status

Data Explorer

API

Description

Is Public

isPublic

The session is public.

Delivery Execution Status

deliveryExecutionStatus

The status of the delivery.

  • Initial: Session created but not yet started.

  • Interacting: The test taker has started interacting with the delivery (session in progress).

  • Closed: The session has been fully scored and results submitted and/or the session is being scored by a human grader.

Active

sessionActive

If the session is active.

Group Active

groupActive

If the session’s assigned group is active.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.