Learning Dashboard

The learningDashboard endpoint returns the Learning Analytics Dashboard data for the session’s meeting.

Access is restricted:

• the session token must belong to a user with the MODERATOR role
• the meeting must be running
• the learningDashboard feature must not be listed in the meeting’s disabledFeatures

The data field of the response contains the dashboard’s JSON document serialized as a string.

Note

This endpoint is part of the client-facing API. A session token obtained through an API join (redirect=false) without a connected HTML5 client will be rejected with Invalid session token.

API Endpoint

GET http://yourserver.com/bigbluebutton/api/learningDashboard?[parameters]

Parameters

Usage Example

use BigBlueButton\BigBlueButton;
use BigBlueButton\Parameters\LearningDashboardParameters;

$bbb = new BigBlueButton();

$learningDashboardParams = new LearningDashboardParameters('xyn1fbqlrhug1j6z');

$response = $bbb->learningDashboard($learningDashboardParams);

if ($response->success()) {
    // the dashboard data is a JSON-encoded string
    $dashboardData = json_decode($response->getData(), true);

    foreach ($dashboardData['users'] as $userId => $user) {
        echo sprintf('%s (%s)', $user['name'], $user['role']) . PHP_EOL;
    }
} else {
    echo 'Error: ' . $response->getMessage();
}

Response Fields