SMsmarterproctoring
Reports

Churn Report

Returns a churn report for the specified install.

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

Path parameters

installSidstring required

Install Sid

Query parameters

courseTitlestring

Course title

examTitlestring

Exam title

emailstring

Student Email

firstNamestring

First Name of student

lastNamestring

Last Name of student

examOpenDatestring

Starting of event, must provide end 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
courseOfferingSidstring

Course Offering Sid

hasCancelledboolean

include if Cancelled session exist

hasClosedboolean

include if closed session exist

currentStatusstring[]

Current status of student

offsetinteger

Result offset

limitinteger

Number of items to return

sortKeysstring[]
sortOrder'ASC' | 'DESC'

Sort order

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 6 revisions of this API.