SMsmarterproctoring
Reports

Exam Overview

Returns an exam overview report for the specified install.

get/v1/installs/{installSid}/reports/examOverview

Request

  • Base URL
    https://api.smarterproctoring.com
  • URL
    https://api.smarterproctoring.com/v1/installs/{installSid}/reports/examOverview
  • Auth
    API key in header token

Path parameters

installSidstring required

Install Sid

Query parameters

courseOfferingSidstring

Course offering

courseTitlestring

Title of the course

courseCodestring

Course code

examTitlestring

Title of the exam

instructorFirstNamestring

First name of the instructor

instructorLastNamestring

Last name of the instructor

examOpenDatestring

Exam Open date, must provide close date with it

Example:1970-01-01T00:00:00.000Z
examCloseDatestring

Exam Close date, must provide open date with it

Example:1970-01-01T00:00:00.000Z
examScheduleOpenDatestring

Exam Session Open date, must provide close date with it

Example:1970-01-01T00:00:00.000Z
examScheduleCloseDatestring

Exam Session Close date, must provide open date with it

Example:1970-01-01T00:00:00.000Z
needsProctorboolean

Show only the exam that needs proctor

offsetinteger

Result offset

limitinteger

Number of items to return

sortBy'status needs proctor' | 'status cancelled' | 'status scheduled' | 'status closed' | 'examOpenDate' | 'examCloseDate' | 'examScheduleOpenDate' | 'examScheduleCloseDate' | 'examTitle' required

Key to sort by

Response

Successful

totalnumber nullable
firststring nullable
nextstring nullable
prevstring nullable
laststring nullable
countnumber nullable
offsetnumber nullable

Changes

No recorded changes to this operation across all 13 revisions of this API.