Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Saurabh-07586/examplatform/llms.txt

Use this file to discover all available pages before exploring further.

ExamPlatform provides administrators with a full suite of data, reporting, and communication tools. The Analytics dashboard surfaces system-wide and subject-wise performance metrics once results are published. The Reports section lets you export per-exam data and the full question bank. Email Notifications allow you to broadcast announcements to any segment of users. The Audit Log captures every significant platform action in a tamper-evident record that can be filtered and searched at any time.

Analytics Dashboard

Navigate to Analytics in the admin sidebar to view aggregated performance data across the entire platform.

Performance Metrics

The top of the Analytics page shows two views of result data:
  • System-wide performance (across all exams) — an aggregate view of all published exam results, including an overall average score, overall pass rate, and completion rate.
  • Subject-wise performance — a table breaking down performance by subject, showing each subject’s average percentage score and the number of attempts recorded.
An AI integrity signal overview is also displayed alongside performance data, giving a platform-wide picture of how sessions are trending on integrity.

Exam Status Breakdown

A status summary shows how exams are distributed across states:
StatusMeaning
LiveCurrently accepting active student sessions
UpcomingScheduled but not yet open
ActiveOpen window but sessions may or may not be in progress
CompletedPast their end time; no further submissions accepted

Published Results Summary

Once results are published, the analytics panel also shows:
  • Published results — the count of exams with published results
  • Overall average — the mean score across all published results
  • Overall pass rate — the percentage of attempts that met the passing threshold
  • Completion rate — the ratio of submitted attempts to assigned attempts
Analytics data is only populated after results have been published for at least one exam. If no results have been published yet, the analytics page displays “No published results yet.” Publish results from the Evaluation & Results section to begin seeing data here.

Reports

Navigate to Reports in the admin sidebar to download exportable data files.

Exam Report

Select any exam from the list to generate a detailed per-exam report. The report includes student scores, pass/fail status, and performance breakdown for that exam.
Click Download PDF to generate a formatted PDF document of the exam report. This is suitable for sharing with institutional stakeholders or printing for records.

Question Bank Report

The Question Bank Report (CSV) provides a full export of every question in the platform’s question bank.
  • Click Download Question Bank CSV to trigger a server-side export.
  • The export is generated server-side and may take a moment for large question banks.
  • The resulting CSV contains all question fields: text, type, difficulty, subject, marks, and answer data.
Downloading the Question Bank CSV requires admin privileges (require_admin). Examiners can access a scoped export of their own questions but cannot export the full bank.

Email Notifications

Navigate to Email Notifications in the admin sidebar to send broadcast messages to platform users.

Sending an Announcement

1

Compose the announcement

Under Send a custom announcement, fill in:
  • Send to — choose the audience: All students, All examiners, or Everyone
  • Subject — the email subject line
  • Message — the body of the announcement
2

Send

Click Send Announcement. The platform dispatches the email to every account in the selected audience group.

Delivery Log

Below the compose form, the Delivery log shows the history of every announcement sent from the platform. Click Refresh to pull the latest entries.
ColumnDescription
RecipientThe audience group or individual the email was sent to
SubjectThe email subject line
TypeThe category of email (e.g., announcement)
StatusDelivery status of the email
SentTimestamp when the email was dispatched
If no emails have been sent yet, the delivery log displays “No emails sent yet.”

Audit Logs

Navigate to Audit Logs in the admin sidebar to access the platform’s complete action history.

Overview

Every significant action taken on ExamPlatform — by any user, on any entity — is recorded as an audit log entry. The log is tamper-evident: entries cannot be modified or deleted, making it the authoritative source of truth for compliance and incident investigation.

Log Columns

ColumnDescription
TimeTimestamp when the action occurred
UserThe account that performed the action
ActionThe action identifier (e.g., exam.publish, admin.create_user)
EntityThe platform object the action was performed on (e.g., a specific exam or user record)
IPThe IP address from which the action was performed

Filtering Audit Logs

Use the Filter input to search by action type. The filter accepts dot-notation action identifiers. Examples of common action values:
ActionMeaning
exam.publishAn exam was published and made visible to students
admin.create_userAn administrator created a new user account
exam.force_submitAn administrator force-submitted a student’s exam session
results.publishExam results were published and made visible to students
If no entries match the current filter, the log displays “No matching audit log entries.”
The audit log is your most powerful tool for investigating integrity incidents. To trace a specific force-submit event, filter by exam.force_submit to see every instance — including which admin performed the action, on which session, and from what IP address. You can also filter by a specific user’s name or email to reconstruct a complete timeline of their activity on the platform.

Build docs developers (and LLMs) love