---
title: "Exams By Week"
method: GET
path: "/v1/installs/{installSid}/examsByWeek"
tags: ["Reports"]
---

# Exams By Week

`GET /v1/installs/{installSid}/examsByWeek`

Returns exams grouped by week based on the given filter parameters.

## Path parameters

- `installSid` string, required — Install Sid

## Query parameters

- `offset` integer — Result offset
- `limit` integer — Number of items to return
- `courseOfferingSid` string — Course offering sid
- `groupBy` 'examOpenDate' | 'examCloseDate' — The base for grouping the exams
- `status` 'past' | 'active' | 'upcoming' — Active status of the exams
- `startDate` string — earliest date to show exams
- `endDate` string — Latest date to show exams

## Response `200`

Successful

- ExamsByWeekReportResponse
  - `total` number, nullable
  - `first` string, nullable
  - `next` string, nullable
  - `prev` string, nullable
  - `last` string, nullable
  - `count` number, nullable
  - `offset` number, nullable
  - `startDate` string, nullable
  - `endDate` string, nullable
  - `lastEvaluatedKey` string, nullable
  - `results` Model4[]

---

[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)