Reports

Exam Volume

Returns an exam volume report for the specified install.

get/v1/installs/{installSid}/examVolume

Request

  • Base URL
    https://api.smarterproctoring.com
  • URL
    https://api.smarterproctoring.com/v1/installs/{installSid}/examVolume
  • Auth
    API key in header token

Path parameters

installSidstring required

Application Install Sid

Query parameters

examOpenDatestring

Exam Open date, must provide close 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

offsetinteger

Offset for pagination

limitinteger

Number of items to return

sortKeysstring[]

Key to sort by

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.