> ## Documentation Index
> Fetch the complete documentation index at: https://developers.smarterservices.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Exam Overview

> Returns an exam overview report for the specified install.



## OpenAPI

````yaml https://api.dev.smarterproctoring.com/openapi.json get /v1/installs/{installSid}/reports/examOverview
openapi: 3.0.0
info:
  title: SmarterProctoring API
  version: 3.0.3
  description: API documentation for SmarterProctoring
servers:
  - url: https://api.smarterproctoring.com
security:
  - client: []
tags:
  - name: App Install
    description: App Install operations
    x-group: App Install
  - name: Course
    description: Course operations
    x-group: Course
  - name: Course Offering
    description: Course Offering operations
    x-group: Course Offering
  - name: Exam
    description: Exam operations
    x-group: Exam
  - name: Exam Configuration
    description: Exam Configuration operations
    x-group: Exam Configuration
  - name: Exam Events
    description: Exam Events operations
    x-group: Exam Events
  - name: Exam Session
    description: Exam Session operations
    x-group: Exam Session
  - name: Exam Session Annotation
    description: Exam Session Annotation operations
    x-group: Exam Session Annotation
  - name: Exam Session Event
    description: Exam Session Event operations
    x-group: Exam Session Event
  - name: Onboarding
    description: Onboarding operations
    x-group: Onboarding
  - name: Provision
    description: Provision operations
    x-group: Provision
  - name: Reports
    description: Reports operations
    x-group: Reports
  - name: Time Zones
    description: Time Zones operations
    x-group: Time Zones
  - name: User
    description: User operations
    x-group: User
paths:
  /v1/installs/{installSid}/reports/examOverview:
    get:
      tags:
        - Reports
      summary: Exam Overview
      description: Returns an exam overview report for the specified install.
      operationId: getV1InstallsInstallsidReportsExamoverview
      parameters:
        - name: installSid
          in: path
          schema:
            type: string
            description: Install Sid
            pattern: ^AI[a-f0-9]{32}$
          description: Install Sid
          required: true
        - name: courseOfferingSid
          in: query
          schema:
            type: string
            description: Course offering
            pattern: ^CO[a-f0-9]{32}$
          description: Course offering
        - name: courseTitle
          in: query
          schema:
            type: string
            description: Title of the course
          description: Title of the course
        - name: courseCode
          in: query
          schema:
            type: string
            description: Course code
          description: Course code
        - name: examTitle
          in: query
          schema:
            type: string
            description: Title of the exam
          description: Title of the exam
        - name: instructorFirstName
          in: query
          schema:
            type: string
            description: First name of the instructor
          description: First name of the instructor
        - name: instructorLastName
          in: query
          schema:
            type: string
            description: Last name of the instructor
          description: Last name of the instructor
        - name: examOpenDate
          in: query
          schema:
            type: string
            description: Exam Open date, must provide close date with it
            example: '1970-01-01T00:00:00.000Z'
            pattern: .*Z
            x-format:
              isoDate: true
          description: Exam Open date, must provide close date with it
        - name: examCloseDate
          in: query
          schema:
            type: string
            description: Exam Close date, must provide open date with it
            example: '1970-01-01T00:00:00.000Z'
            pattern: .*Z
            x-format:
              isoDate: true
          description: Exam Close date, must provide open date with it
        - name: examScheduleOpenDate
          in: query
          schema:
            type: string
            description: Exam Session Open date, must provide close date with it
            example: '1970-01-01T00:00:00.000Z'
            pattern: .*Z
            x-format:
              isoDate: true
          description: Exam Session Open date, must provide close date with it
        - name: examScheduleCloseDate
          in: query
          schema:
            type: string
            description: Exam Session Close date, must provide open date with it
            example: '1970-01-01T00:00:00.000Z'
            pattern: .*Z
            x-format:
              isoDate: true
          description: Exam Session Close date, must provide open date with it
        - name: needsProctor
          in: query
          schema:
            type: boolean
            description: Show only the exam that needs proctor
          description: Show only the exam that needs proctor
        - name: offset
          in: query
          schema:
            type: integer
            description: Result offset
            minimum: 0
          description: Result offset
        - name: limit
          in: query
          schema:
            type: integer
            description: Number of items to return
            minimum: 0
          description: Number of items to return
        - name: sortBy
          in: query
          schema:
            type: string
            description: Key to sort by
            enum:
              - status needs proctor
              - status cancelled
              - status scheduled
              - status closed
              - examOpenDate
              - examCloseDate
              - examScheduleOpenDate
              - examScheduleCloseDate
              - examTitle
          description: Key to sort by
          required: true
      responses:
        '200':
          description: Successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExamOverviewReportResponse'
components:
  schemas:
    ExamOverviewReportResponse:
      type: object
      properties:
        total:
          type: number
          nullable: true
        first:
          type: string
          nullable: true
        next:
          type: string
          nullable: true
        prev:
          type: string
          nullable: true
        last:
          type: string
          nullable: true
        count:
          type: number
          nullable: true
        offset:
          type: number
          nullable: true
        results:
          $ref: '#/components/schemas/Model16'
    Model16:
      type: array
      items:
        $ref: '#/components/schemas/ExamOverviewItem'
    ExamOverviewItem:
      type: object
      properties:
        sid:
          type: string
          nullable: true
        courseSid:
          type: string
          nullable: true
        title:
          type: string
          nullable: true
        bVirtualTitle:
          type: string
          nullable: true
        type:
          type: string
          nullable: true
        description:
          type: string
          nullable: true
        useProctorManager:
          type: boolean
          nullable: true
        requireApproval:
          type: boolean
          nullable: true
        enableAppointmentSuggestions:
          type: boolean
          nullable: true
        url:
          type: string
          nullable: true
        status:
          type: string
          nullable: true
        createdDate:
          type: string
          nullable: true
        editDate:
          type: string
          nullable: true
        examDeliverySystemModule:
          type: string
          nullable: true
        instructorName:
          type: string
          nullable: true
        courseName:
          type: string
          nullable: true
        totalSessions:
          type: number
          nullable: true
        needsProctorSessions:
          type: number
          nullable: true
        platformVersion:
          type: string
          nullable: true
  securitySchemes:
    client:
      type: apiKey
      name: token
      in: header

````