Assess API Initialization

Used to define time parameters including countdown and expiry settings.

This configuration can also be set inside each sections to define the time parameters of each sections.

Note When using sections and a time configuration has been set in any section, the global time configuration will be ignored.

From v2026.2.LTS, learners can show or hide the main assessment timer during an assessment by clicking it, or by pressing Space or Enter when it has focus. This can help reduce test anxiety caused by a constantly updating timer display.

Note The timer can only be hidden while more than 5 minutes remain in a timed session. This threshold is not configurable.

When 5 minutes remain in a timed session, the following happens automatically regardless of learner preference:

• The timer reappears if it was hidden.
• The ability to hide the timer is disabled for the rest of the session.
• Screen readers announce the remaining time through an aria-live region.

Examples

"time": {
    "max_time": 0,
    "limit_type": "soft",
    "warning_time": 60,
    "countdown_option": true,
    "countdown": 10
}

Values

Attribute path time

Type object

Properties

• countdown number

  Count down time in seconds shown in administrator remote control modal - integer.

• countdown_option boolean

  Enable the count down timer.

• limit_type string

  Specify the action when the time limit expires.

• max_time number

  The length of test session, in seconds.

• warning_time number

  If set, the Assess API will show a visual dialog when the session has warning_time seconds left - integer.

Caveats

• The automatic timer reappearance, hide restriction, and screen reader announcement behavior apply only when max_time is configured.
• For assessments with unlimited time, learners can continue to hide or show the main assessment timer throughout the session.
• Only the main assessment timer can be hidden. The timer shown in the Submit, Pause, and Accessibility modal windows is always visible.