---
title: "Churn Report"
method: GET
path: "/v1/installs/{installSid}/reports/churn"
tags: ["Reports"]
---

# Churn Report

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

## Request

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

Returns a churn report for the specified install.

## Path parameters

- `installSid` string, required: Install Sid

## Query parameters

- `courseTitle` string: Course title
- `examTitle` string: Exam title
- `email` string: Student Email
- `firstName` string: First Name of student
- `lastName` string: Last Name of student
- `examOpenDate` string: Starting of event, must provide end date with it
- `examCloseDate` string: Exam Close date, must provide open date with it
- `courseOfferingSid` string: Course Offering Sid
- `hasCancelled` boolean: include if Cancelled session exist
- `hasClosed` boolean: include if closed session exist
- `currentStatus` string[]: Current status of student
- `offset` integer: Result offset
- `limit` integer: Number of items to return
- `sortKeys` string[]
- `sortOrder` 'ASC' | 'DESC': Sort order

## Response `200`

Successful

- ChurnReportResponse
  - `total` number, nullable
  - `first` string, nullable
  - `next` string, nullable
  - `prev` string, nullable
  - `last` string, nullable
  - `count` number, nullable
  - `offset` number, nullable
  - `results` ChurnReportItem[]
    - `courseTitle` string, nullable
    - `examSid` string, nullable
    - `examTitle` string, nullable
    - `examType` string, nullable
    - `userSid` string, nullable
    - `enrollmentSid` string, nullable
    - `firstName` string, nullable
    - `lastName` string, nullable
    - `email` string, nullable
    - `preferredEmail` string, nullable
    - `homePhone` string, nullable
    - `mobilePhone` string, nullable
    - `currentSessionSid` string, nullable
    - `currentStatus` string, nullable
    - `cancelled` boolean, nullable
    - `closed` boolean, nullable

---

[API](https://skmtc.dev/smarterproctoring/apis/smarterproctoring-api-2.md) - [All operations](https://skmtc.dev/smarterproctoring/apis/smarterproctoring-api-2/llms.txt) - [OpenAPI document](https://skmtc.dev/smarterproctoring/apis/smarterproctoring-api-2/revisions/7199a3921c9d?raw)