---
title: "Exam Overview"
method: GET
path: "/v1/installs/{installSid}/reports/examOverview"
tags: ["Reports"]
---

# Exam Overview

`GET /v1/installs/{installSid}/reports/examOverview`

Returns an exam overview report for the specified install.

## Path parameters

- `installSid` string, required — Install Sid

## Query parameters

- `courseOfferingSid` string — Course offering
- `courseTitle` string — Title of the course
- `courseCode` string — Course code
- `examTitle` string — Title of the exam
- `instructorFirstName` string — First name of the instructor
- `instructorLastName` string — Last name of the instructor
- `examOpenDate` string — Exam Open date, must provide close date with it
- `examCloseDate` string — Exam Close date, must provide open date with it
- `examScheduleOpenDate` string — Exam Session Open date, must provide close date with it
- `examScheduleCloseDate` string — Exam Session Close date, must provide open date with it
- `needsProctor` boolean — Show only the exam that needs proctor
- `offset` integer — Result offset
- `limit` integer — 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 `200`

Successful

- ExamOverviewReportResponse
  - `total` number, nullable
  - `first` string, nullable
  - `next` string, nullable
  - `prev` string, nullable
  - `last` string, nullable
  - `count` number, nullable
  - `offset` number, nullable
  - `results` ExamOverviewItem[]
    - `sid` string, nullable
    - `courseSid` string, nullable
    - `title` string, nullable
    - `bVirtualTitle` string, nullable
    - `type` string, nullable
    - `description` string, nullable
    - `useProctorManager` boolean, nullable
    - `requireApproval` boolean, nullable
    - `enableAppointmentSuggestions` boolean, nullable
    - `url` string, nullable
    - `status` string, nullable
    - `createdDate` string, nullable
    - `editDate` string, nullable
    - `examDeliverySystemModule` string, nullable
    - `instructorName` string, nullable
    - `courseName` string, nullable
    - `totalSessions` number, nullable
    - `needsProctorSessions` number, nullable
    - `platformVersion` string, nullable

---

[API](https://skmtc.net/smarterproctoring/apis/smarterproctoring-api-2.md) · [All operations](https://skmtc.net/smarterproctoring/apis/smarterproctoring-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/smarterproctoring/smarterproctoring-api-2/versions/561e0d9fd244/schema)